solargraph 0.39.17 → 0.40.0

data/lib/solargraph/yard_map/mapper/to_method.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class YardMap
+    class Mapper
+      module ToMethod
+        extend YardMap::Helpers
+
+        def self.make code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil
+          closure ||= Solargraph::Pin::Namespace.new(
+            name: code_object.namespace.to_s,
+            gates: [code_object.namespace.to_s]
+          )
+          location = object_location(code_object, spec)
+          comments = code_object.docstring ? code_object.docstring.all.to_s : ''
+          Pin::Method.new(
+            location: location,
+            closure: closure,
+            name: name || code_object.name.to_s,
+            comments: comments,
+            scope: scope || code_object.scope,
+            visibility: visibility || code_object.visibility,
+            parameters: get_parameters(code_object, location, comments),
+            explicit: code_object.is_explicit?
+          )
+        end
+
+        class << self
+          private
+
+          # @param code_object [YARD::CodeObjects::Base]
+          # @return [Array<Solargraph::Pin::Parameter>]
+          def get_parameters code_object, location, comments
+            return [] unless code_object.is_a?(YARD::CodeObjects::MethodObject)
+            # HACK: Skip `nil` and `self` parameters that are sometimes emitted
+            # for methods defined in C
+            # See https://github.com/castwide/solargraph/issues/345
+            code_object.parameters.select { |a| a[0] && a[0] != 'self' }.map do |a|
+              Solargraph::Pin::Parameter.new(
+                location: location,
+                closure: self,
+                comments: comments,
+                name: arg_name(a),
+                presence: nil,
+                decl: arg_type(a),
+                asgn_code: a[1]
+              )
+            end
+          end
+
+          # @param a [Array]
+          # @return [String]
+          def arg_name a
+            a[0].gsub(/[^a-z0-9_]/i, '')
+          end
+
+          # @param a [Array]
+          # @return [::Symbol]
+          def arg_type a
+            if a[0].start_with?('**')
+              :kwrestarg
+            elsif a[0].start_with?('*')
+              :restarg
+            elsif a[0].start_with?('&')
+              :blockarg
+            elsif a[0].end_with?(':')
+              a[1] ? :kwoptarg : :kwarg
+            elsif a[1]
+              :optarg
+            else
+              :arg
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/{pin/yard_pin/namespace.rb → yard_map/mapper/to_namespace.rb}

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 module Solargraph
-  module Pin
-    module YardPin
-      class Namespace < Pin::Namespace
-        include YardMixin
+  class YardMap
+    class Mapper
+      module ToNamespace
+        extend YardMap::Helpers
 
-        def initialize code_object, spec, closure = nil
+        def self.make code_object, spec, closure = nil
           closure ||= Solargraph::Pin::Namespace.new(
             name: code_object.namespace.to_s,
             closure: Pin::ROOT_PIN,
             gates: [code_object.namespace.to_s]
           )
-          super(
+          Pin::Namespace.new(
             location: object_location(code_object, spec),
             name: code_object.name.to_s,
             comments: code_object.docstring ? code_object.docstring.all.to_s : '',

data/lib/solargraph/yard_map/rdoc_to_yard.rb

@@ -63,7 +63,7 @@ module Solargraph
               name_hash[mod.full_name] = namepin
               # @param met [RDoc::AnyMethod]
               mod.each_method do |met|
-                pin = Solargraph::SourceMap.load_string("def Object.tmp#{met.param_seq};end").first_pin('Object.tmp') || Solargraph::Pin::BaseMethod.new
+                pin = Solargraph::SourceMap.load_string("def Object.tmp#{met.param_seq};end").first_pin('Object.tmp') || Solargraph::Pin::Method.new
                 pins.push Solargraph::Pin::Method.new(
                   name: met.name,
                   closure: namepin,

data/lib/solargraph/yard_map/stdlib_fills.rb

@@ -0,0 +1,43 @@
+module Solargraph
+  class YardMap
+    module StdlibFills
+      Override = Pin::Reference::Override
+
+      LIBS = {
+        'benchmark' => [
+          Override.method_return('Benchmark.measure', 'Benchmark::Tms')
+        ],
+
+        'pathname' => [
+          Override.method_return('Pathname#join', 'Pathname'),
+          Override.method_return('Pathname#basename', 'Pathname'),
+          Override.method_return('Pathname#dirname', 'Pathname'),
+          Override.method_return('Pathname#cleanpath', 'Pathname'),
+          Override.method_return('Pathname#children', 'Array<Pathname>'),
+          Override.method_return('Pathname#entries', 'Array<Pathname>')
+        ],
+
+        'set' => [
+          Override.method_return('Enumerable#to_set', 'Set'),
+          Override.method_return('Set#add', 'self'),
+          Override.method_return('Set#add?', 'self, nil'),
+          Override.method_return('Set#classify', 'Hash'),
+          Override.from_comment('Set#each', '@yieldparam_single_parameter'),
+        ],
+
+        'tempfile' => [
+          Override.from_comment('Tempfile.open', %(
+@yieldparam [Tempfile]
+@return [Tempfile]
+          ))
+        ]
+      }.freeze
+
+      # @param path [String]
+      # @return [Array<Pin::Reference::Override>]
+      def self.get path
+        LIBS[path] || []
+      end
+    end
+  end
+end

data/lib/solargraph/{pin/yard_pin/method.rb → yard_map/to_method.rb}

@@ -1,39 +1,14 @@
 # frozen_string_literal: true
 
 module Solargraph
-  module Pin
-    module YardPin
-      class Method < Pin::Method
-        include YardMixin
-
-        # @param code_object [YARD::CodeObjects::Base]
-        # @param name [String, nil]
-        # @param scope [Symbol, nil]
-        # @param visibility [Symbol, nil]
-        # @param closure [Solargraph::Pin::Closure, nil]
-        # @param spec [Gem::Specification]
-        def initialize code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil
-          closure ||= Solargraph::Pin::Namespace.new(
-            name: code_object.namespace.to_s,
-            gates: [code_object.namespace.to_s]
-          )
-          super(
-            location: object_location(code_object, spec),
-            closure: closure,
-            name: name || code_object.name.to_s,
-            comments: code_object.docstring ? code_object.docstring.all.to_s : '',
-            scope: scope || code_object.scope,
-            visibility: visibility || code_object.visibility,
-            parameters: get_parameters(code_object),
-            explicit: code_object.is_explicit?
-          )
-        end
-
-        private
+  class YardMap
+    class ToMethod
+      module InnerMethods
+        module_function
 
         # @param code_object [YARD::CodeObjects::Base]
         # @return [Array<Solargraph::Pin::Parameter>]
-        def get_parameters code_object
+        def get_parameters code_object, location, comments
           return [] unless code_object.is_a?(YARD::CodeObjects::MethodObject)
           # HACK: Skip `nil` and `self` parameters that are sometimes emitted
           # for methods defined in C
@@ -75,6 +50,30 @@ module Solargraph
           end
         end
       end
+      private_constant :InnerMethods
+
+      # include YardMixin
+      # extend YardMixin
+      extend Helpers
+
+      def make code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil
+        closure ||= Solargraph::Pin::Namespace.new(
+          name: code_object.namespace.to_s,
+          gates: [code_object.namespace.to_s]
+        )
+        location = object_location(code_object, spec)
+        comments = code_object.docstring ? code_object.docstring.all.to_s : ''
+        Pin::Method.new(
+          location: location,
+          closure: closure,
+          name: name || code_object.name.to_s,
+          comments: comments,
+          scope: scope || code_object.scope,
+          visibility: visibility || code_object.visibility,
+          parameters: InnerMethods.get_parameters(code_object, location, comments),
+          explicit: code_object.is_explicit?
+        )
+      end
     end
   end
 end

data/solargraph.gemspec

@@ -17,18 +17,18 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
   s.executables = ['solargraph']
 
-  s.required_ruby_version = '>= 2.1'
+  s.required_ruby_version = '>= 2.4'
 
   s.add_runtime_dependency 'backport', '~> 1.1'
   s.add_runtime_dependency 'benchmark'
   s.add_runtime_dependency 'bundler', '>= 1.17.2'
   s.add_runtime_dependency 'e2mmap'
   s.add_runtime_dependency 'jaro_winkler', '~> 1.5'
-  s.add_runtime_dependency 'maruku', '~> 0.7', '>= 0.7.3'
-  s.add_runtime_dependency 'nokogiri', '~> 1.9', '>= 1.9.1'
+  s.add_runtime_dependency 'kramdown', '~> 2.3'
+  s.add_runtime_dependency 'kramdown-parser-gfm', '~> 1.1'
   s.add_runtime_dependency 'parser', '~> 2.3'
   s.add_runtime_dependency 'reverse_markdown', '>= 1.0.5', '< 3'
-  s.add_runtime_dependency 'rubocop', '~> 0.52'
+  s.add_runtime_dependency 'rubocop', '>= 0.52'
   s.add_runtime_dependency 'thor', '~> 1.0'
   s.add_runtime_dependency 'tilt', '~> 2.0'
   s.add_runtime_dependency 'yard', '~> 0.9', '>= 0.9.24'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.39.17
+  version: 0.40.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -81,45 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: maruku
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: kramdown-parser-gfm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -158,14 +146,14 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.52'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.52'
 - !ruby/object:Gem::Dependency
@@ -303,6 +291,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -316,7 +305,7 @@ files:
 - lib/solargraph/api_map/cache.rb
 - lib/solargraph/api_map/source_to_yard.rb
 - lib/solargraph/api_map/store.rb
-- lib/solargraph/bundle.rb
+- lib/solargraph/bench.rb
 - lib/solargraph/compat.rb
 - lib/solargraph/complex_type.rb
 - lib/solargraph/complex_type/type_methods.rb
@@ -330,7 +319,6 @@ files:
 - lib/solargraph/converters/dl.rb
 - lib/solargraph/converters/dt.rb
 - lib/solargraph/converters/misc.rb
-- lib/solargraph/core_fills.rb
 - lib/solargraph/diagnostics.rb
 - lib/solargraph/diagnostics/base.rb
 - lib/solargraph/diagnostics/require_not_found.rb
@@ -460,9 +448,7 @@ files:
 - lib/solargraph/parser/rubyvm/node_processors/sym_node.rb
 - lib/solargraph/parser/snippet.rb
 - lib/solargraph/pin.rb
-- lib/solargraph/pin/attribute.rb
 - lib/solargraph/pin/base.rb
-- lib/solargraph/pin/base_method.rb
 - lib/solargraph/pin/base_variable.rb
 - lib/solargraph/pin/block.rb
 - lib/solargraph/pin/class_variable.rb
@@ -492,11 +478,6 @@ files:
 - lib/solargraph/pin/reference/superclass.rb
 - lib/solargraph/pin/singleton.rb
 - lib/solargraph/pin/symbol.rb
-- lib/solargraph/pin/yard_pin.rb
-- lib/solargraph/pin/yard_pin/constant.rb
-- lib/solargraph/pin/yard_pin/method.rb
-- lib/solargraph/pin/yard_pin/namespace.rb
-- lib/solargraph/pin/yard_pin/yard_mixin.rb
 - lib/solargraph/position.rb
 - lib/solargraph/range.rb
 - lib/solargraph/server_methods.rb
@@ -524,7 +505,6 @@ files:
 - lib/solargraph/source_map/clip.rb
 - lib/solargraph/source_map/completion.rb
 - lib/solargraph/source_map/mapper.rb
-- lib/solargraph/stdlib_fills.rb
 - lib/solargraph/type_checker.rb
 - lib/solargraph/type_checker/checks.rb
 - lib/solargraph/type_checker/param_def.rb
@@ -543,12 +523,18 @@ files:
 - lib/solargraph/yard_map.rb
 - lib/solargraph/yard_map/cache.rb
 - lib/solargraph/yard_map/core_docs.rb
+- lib/solargraph/yard_map/core_fills.rb
 - lib/solargraph/yard_map/core_gen.rb
+- lib/solargraph/yard_map/helpers.rb
 - lib/solargraph/yard_map/mapper.rb
+- lib/solargraph/yard_map/mapper/to_constant.rb
+- lib/solargraph/yard_map/mapper/to_method.rb
+- lib/solargraph/yard_map/mapper/to_namespace.rb
 - lib/solargraph/yard_map/rdoc_to_yard.rb
+- lib/solargraph/yard_map/stdlib_fills.rb
+- lib/solargraph/yard_map/to_method.rb
 - lib/yard-solargraph.rb
 - solargraph.gemspec
-- travis-bundler.rb
 - yardoc/2.2.2.tar.gz
 homepage: http://solargraph.org
 licenses:
@@ -562,7 +548,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/solargraph/core_fills.rb

@@ -1,164 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # Overrides for the Ruby core.
-  #
-  # The YardMap uses this module to add type information to core methods.
-  #
-  module CoreFills
-    Override = Pin::Reference::Override
-
-    KEYWORDS = [
-      '__ENCODING__', '__LINE__', '__FILE__', 'BEGIN', 'END', 'alias', 'and',
-      'begin', 'break', 'case', 'class', 'def', 'defined?', 'do', 'else',
-      'elsif', 'end', 'ensure', 'false', 'for', 'if', 'in', 'module', 'next',
-      'nil', 'not', 'or', 'redo', 'rescue', 'retry', 'return', 'self', 'super',
-      'then', 'true', 'undef', 'unless', 'until', 'when', 'while', 'yield'
-    ].freeze
-
-    methods_with_yieldparam_subtypes = %w[
-      Array#each Array#map 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
-    ]
-
-    OVERRIDES = [
-      Override.method_return('Array#keep_if', 'self'),
-      Override.method_return('Array#delete_if', 'self'),
-      Override.from_comment('Array#reject', %(
-@overload reject(&block)
-  @return [self]
-@overload reject()
-  @return [Enumerator]
-              )),
-      Override.method_return('Array#reverse', 'self', delete: ['overload']),
-      Override.from_comment('Array#select', %(
-@overload select(&block)
-  @return [self]
-@overload select()
-  @return [Enumerator]
-      )),
-      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.method_return('Array#concat', 'Array'),
-      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('Array#map', 'Array'),
-      Override.method_return('Array#uniq', 'self'),
-      Override.method_return('Array#zip', 'Array, nil'),
-
-      Override.from_comment('BasicObject#==', %(
-@param other [BasicObject]
-@return [Boolean]
-      )),
-      Override.method_return('BasicObject#initialize', 'void'),
-
-      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.method_return('Enumerable#select', 'self'),
-
-      Override.method_return('File.absolute_path', 'String'),
-      Override.method_return('File.basename', 'String'),
-      Override.method_return('File.dirname', 'String'),
-      Override.method_return('File.extname', 'String'),
-      Override.method_return('File.join', 'String'),
-
-      Override.from_comment('Float#+', %(
-@param y [Numeric]
-@return [Numeric]
-      )),
-
-      Override.from_comment('Hash#[]', %(
-@return_value_parameter
-      )),
-
-      # @todo This override isn't robust enough. It needs to allow for
-      #   parameterized Hash types, e.g., [Hash{Symbol => String}].
-      Override.from_comment('Hash#[]=', %(
-@param_tuple
-      )),
-
-      Override.method_return('Hash#merge', 'Hash'),
-
-      Override.from_comment('Integer#+', %(
-@param y [Numeric]
-@return [Numeric]
-      )),
-
-      Override.method_return('Kernel#puts', 'nil'),
-
-      Override.from_comment('Numeric#+', %(
-@param y [Numeric]
-@return [Numeric]
-      )),
-
-      Override.method_return('Object#!', 'Boolean'),
-      Override.method_return('Object#clone', 'self', delete: [:overload]),
-      Override.method_return('Object#dup', 'self', delete: [:overload]),
-      Override.method_return('Object#freeze', 'self', delete: [:overload]),
-      Override.method_return('Object#inspect', 'String'),
-      Override.method_return('Object#taint', 'self'),
-      Override.method_return('Object#to_s', 'String'),
-      Override.method_return('Object#untaint', 'self'),
-      Override.from_comment('Object#tap', %(
-@return [self]
-@yieldparam [self]
-      )),
-
-      Override.from_comment('STDERR', %(
-@type [IO]
-      )),
-
-      Override.from_comment('STDIN', %(
-@type [IO]
-      )),
-
-      Override.from_comment('STDOUT', %(
-@type [IO]
-      )),
-
-      Override.method_return('String#freeze', 'self'),
-      Override.method_return('String#split', 'Array<String>'),
-      Override.method_return('String#lines', 'Array<String>'),
-      Override.from_comment('String#each_line', %(
-@yieldparam [String]
-      )),
-      Override.from_comment('String.new', %(
-@overload new(*)
-  @return [self]
-      ))
-    ].concat(
-      methods_with_yieldparam_subtypes.map do |path|
-        Override.from_comment(path, %(
-@yieldparam_single_parameter
-          ))
-      end
-    )
-  end
-end