solargraph 0.44.0 → 0.44.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0827e2be47eea923c2f61688ce4e97efa11d3d801f094ffb8a6cdb73a7fb52b3'
-  data.tar.gz: dcbad1eaa64acab63ccc511a93c0e1370fc469815e2e67735fc79c2f4dc08038
+  metadata.gz: 346926f891270e103d6c7170fe5897587c1d5da45ea33b2a7f4238914b38b236
+  data.tar.gz: 451b09bf70dc9d760ebfdeb726821e6e653f196bd867da8c7638888803e33a72
 SHA512:
-  metadata.gz: fa050d901186e2385685d2aab7934f611517d68b549f4cb064ab7c3524f99e890488675a06483c2b1f2e2cafc0417a3367972a1ea8b6c6614a3465e867313b03
-  data.tar.gz: 4b12d6b0f65f53afd0ccbbdfc84a9fe8159f2f3a4bb3c625a84f1a9ee80be53f8c8b1d1ecfbae9bcf01ceff691388af5d0cef7271bb5470730fc4aa7a2471df9
+  metadata.gz: 624d1de49ef2762477d7a413adf282a058143a71689ea8cdfcc91177db94c765b997fca00fefd8d0d4915e44e6cd4ae1867297671611ba6d119d610116c5b80a
+  data.tar.gz: 9f146a371e075407cb8be7b96de08ff24583cf18eb1a29310c1a711c1bd347715d07b0ff6603e9a98b71be7406148e17c907abdcf3bd1a2aba58bd5aeff14685

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.44.1 - November 18, 2021
+- Chain nil safety navigation operator (#420)
+- Update closure and context for class_eval receiver (#487)
+- SourceMap::Mapper handles invalid byte sequences (#474)
+- Special handle var= references, which may use as var = (have space) (#498)
+- Rebind define_method to self (#494)
+
 ## 0.44.0 - September 27, 2021
 - Allow opening parenthesis, space, and comma when using Diff::LCS (#465)
 - Support textDocument/documentHighlight

data/lib/solargraph/complex_type.rb

@@ -87,6 +87,10 @@ module Solargraph
       ComplexType.parse(*result.map(&:tag))
     end
 
+    def nullable?
+      @items.any?(&:nil_type?)
+    end
+
     private
 
     # @todo This is a quick and dirty hack that forces `self` keywords

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -31,7 +31,7 @@ module Solargraph
       # @param code [String]
       # @return [Array(Array<String>, Array<String>)]
       def generate_options filename, code
-        args = ['-f', 'j', filename]
+        args = ['-f', 'j', '--force-exclusion', filename]
         base_options = RuboCop::Options.new
         options, paths = base_options.parse(args)
         options[:stdin] = code

data/lib/solargraph/parser/legacy/node_chainer.rb

@@ -71,6 +71,23 @@ module Solargraph
             else
               raise "No idea what to do with #{n}"
             end
+          elsif n.type == :csend
+            if n.children[0].is_a?(::Parser::AST::Node)
+              result.concat generate_links(n.children[0])
+              args = []
+              n.children[2..-1].each do |c|
+                args.push NodeChainer.chain(c)
+              end
+              result.push Chain::QCall.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
+            elsif n.children[0].nil?
+              args = []
+              n.children[2..-1].each do |c|
+                args.push NodeChainer.chain(c)
+              end
+              result.push Chain::QCall.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
+            else
+              raise "No idea what to do with #{n}"
+            end
           elsif n.type == :self
             result.push Chain::Head.new('self')
           elsif n.type == :zsuper

data/lib/solargraph/parser/legacy/node_processors/block_node.rb

@@ -5,15 +5,39 @@ module Solargraph
     module Legacy
       module NodeProcessors
         class BlockNode < Parser::NodeProcessor::Base
+          include Legacy::NodeMethods
+
           def process
+            if other_class_eval?
+              other_class = Solargraph::Pin::Namespace.new(
+                type: :class,
+                name: unpack_name(node.children[0].children[0])
+              )
+              make_block_in other_class.context
+              process_children region.update(closure: other_class)
+            else
+              make_block_in nil
+              process_children region.update(closure: pins.last)
+            end
+          end
+
+          private
+
+          def other_class_eval?
+            node.children[0].type == :send &&
+              node.children[0].children[1] == :class_eval &&
+              [:cbase, :const].include?(node.children[0].children[0]&.type)
+          end
+
+          def make_block_in context
             pins.push Solargraph::Pin::Block.new(
               location: get_node_location(node),
+              context: context,
               closure: region.closure,
               receiver: node.children[0],
               comments: comments_for(node),
               scope: region.scope || region.closure.context.scope
             )
-            process_children region.update(closure: pins.last)
           end
         end
       end

data/lib/solargraph/parser/rubyvm/class_methods.rb

@@ -40,11 +40,16 @@ module Solargraph
         # end
 
         def references source, name
+          if name.end_with?("=")
+            reg = /#{Regexp.escape name[0..-2]}\s*=/
+            extract_offset = ->(code, offset) { reg.match(code, offset).offset(0) }
+          else
+            extract_offset = ->(code, offset) { [soff = code.index(name, offset), soff + name.length] }
+          end
           inner_node_references(name, source.node).map do |n|
             rng = Range.from_node(n)
             offset = Position.to_offset(source.code, rng.start)
-            soff = source.code.index(name, offset)
-            eoff = soff + name.length
+            soff, eoff = extract_offset[source.code, offset]
             Location.new(
               source.filename,
               Range.new(

data/lib/solargraph/parser/rubyvm/node_chainer.rb

@@ -60,6 +60,11 @@ module Solargraph
               result.concat generate_links(c)
             end
             result.push Chain::Call.new(n.children[-2].to_s, node_to_argchains(n.children.last), @in_block > 0 || block_passed?(n))
+          elsif n.type == :QCALL
+            n.children[0..-3].each do |c|
+              result.concat generate_links(c)
+            end
+            result.push Chain::QCall.new(n.children[-2].to_s, node_to_argchains(n.children.last), @in_block > 0 || block_passed?(n))
           elsif n.type == :ATTRASGN
             result.concat generate_links(n.children[0])
             result.push Chain::Call.new(n.children[1].to_s, node_to_argchains(n.children[2]), @in_block > 0 || block_passed?(n))

data/lib/solargraph/parser/rubyvm/node_processors/block_node.rb

@@ -5,15 +5,39 @@ module Solargraph
     module Rubyvm
       module NodeProcessors
         class BlockNode < Parser::NodeProcessor::Base
+          include NodeMethods
+
           def process
+            if other_class_eval?
+              other_class = Solargraph::Pin::Namespace.new(
+                type: :class,
+                name: unpack_name(node.children[0].children[0])
+              )
+              make_block_in other_class.context
+              process_children region.update(closure: other_class)
+            else
+              make_block_in nil
+              process_children region.update(closure: pins.last)
+            end
+          end
+
+          private
+
+          def other_class_eval?
+            node.children[0].type == :CALL &&
+              node.children[0].children[1] == :class_eval &&
+              [:COLON2, :CONST].include?(node.children[0].children[0].type)
+          end
+
+          def make_block_in context
             pins.push Solargraph::Pin::Block.new(
               location: get_node_location(node),
+              context: context,
               closure: region.closure,
               receiver: node.children[0],
               comments: comments_for(node),
               scope: region.scope || region.closure.context.scope
             )
-            process_children region.update(closure: pins.last)
           end
         end
       end

data/lib/solargraph/pin/block.rb

@@ -8,9 +8,10 @@ module Solargraph
       # @return [Parser::AST::Node]
       attr_reader :receiver
 
-      def initialize receiver: nil, args: [], **splat
+      def initialize receiver: nil, args: [], context: nil, **splat
         super(**splat)
         @receiver = receiver
+        @context = context
         @parameters = args
       end
 
@@ -44,15 +45,24 @@ module Solargraph
         return nil unless api_map.rebindable_method_names.include?(word)
         chain = Parser.chain(receiver, location.filename)
         locals = api_map.source_map(location.filename).locals_at(location)
-        if ['instance_eval', 'instance_exec', 'class_eval', 'class_exec', 'module_eval', 'module_exec'].include?(chain.links.last.word)
+        links_last_word = chain.links.last.word
+        if %w[instance_eval instance_exec class_eval class_exec module_eval module_exec].include?(links_last_word)
           return chain.base.infer(api_map, self, locals)
-        else
-          receiver_pin = chain.define(api_map, self, locals).first
-          if receiver_pin && receiver_pin.docstring
-            ys = receiver_pin.docstring.tag(:yieldself)
-            if ys && ys.types && !ys.types.empty?
-              return ComplexType.try_parse(*ys.types).qualify(api_map, receiver_pin.context.namespace)
-            end
+        end
+        if 'define_method' == links_last_word and chain.define(api_map, self, locals).first&.path == 'Module#define_method' # change class type to instance type
+          if chain.links.size > 1 # Class.define_method
+            ty = chain.base.infer(api_map, self, locals)
+            return Solargraph::ComplexType.parse(ty.namespace)
+          else # define_method without self
+            return Solargraph::ComplexType.parse(closure.binder.namespace)
+          end
+        end
+        # other case without early return, read block yieldself tags
+        receiver_pin = chain.define(api_map, self, locals).first
+        if receiver_pin && receiver_pin.docstring
+          ys = receiver_pin.docstring.tag(:yieldself)
+          if ys && ys.types && !ys.types.empty?
+            return ComplexType.try_parse(*ys.types).qualify(api_map, receiver_pin.context.namespace)
           end
         end
         nil

data/lib/solargraph/pin/documenting.rb

@@ -80,7 +80,7 @@ module Solargraph
               end
             end
           end
-          sections.map(&:to_s).join
+          sections.map(&:to_s).join.strip
         end
       end
 

data/lib/solargraph/pin/local_variable.rb

@@ -18,19 +18,7 @@ module Solargraph
         true
       end
 
-      # @param other [Pin::Base] The caller's block
-      # @param position [Position, Array(Integer, Integer)] The caller's position
-      # @return [Boolean]
-      def visible_from?(other, position)
-        position = Position.normalize(position)
-        other.filename == filename &&
-          match_tags(other.full_context.tag, full_context.tag) &&
-          (other == closure ||
-            (closure.location.range.contain?(other.location.range.start) && closure.location.range.contain?(other.location.range.ending))
-          ) &&
-          presence.contain?(position)
-      end
-
+      # @param other_closure [Pin::Closure]
       # @param other_loc [Location]
       def visible_at?(other_closure, other_loc)
         return true if location.filename == other_loc.filename &&

data/lib/solargraph/source/chain/link.rb

@@ -51,6 +51,10 @@ module Solargraph
           clone.mark_head(false)
         end
 
+        def nullable?
+          false
+        end
+
         protected
 
         # Mark whether this link is the head of a chain

data/lib/solargraph/source/chain/q_call.rb

@@ -0,0 +1,11 @@
+module Solargraph
+  class Source
+    class Chain
+      class QCall < Call
+        def nullable?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/source/chain.rb

@@ -11,6 +11,7 @@ module Solargraph
     class Chain
       autoload :Link,             'solargraph/source/chain/link'
       autoload :Call,             'solargraph/source/chain/call'
+      autoload :QCall,            'solargraph/source/chain/q_call'
       autoload :Variable,         'solargraph/source/chain/variable'
       autoload :ClassVariable,    'solargraph/source/chain/class_variable'
       autoload :Constant,         'solargraph/source/chain/constant'
@@ -76,7 +77,8 @@ module Solargraph
       # @return [ComplexType]
       def infer api_map, name_pin, locals
         pins = define(api_map, name_pin, locals)
-        infer_first_defined(pins, links.last.last_context, api_map)
+        type = infer_first_defined(pins, links.last.last_context, api_map)
+        maybe_nil(type)
       end
 
       # @return [Boolean]
@@ -101,6 +103,10 @@ module Solargraph
         @splat
       end
 
+      def nullable?
+        links.any?(&:nullable?)
+      end
+
       private
 
       # @param pins [Array<Pin::Base>]
@@ -146,6 +152,13 @@ module Solargraph
         return type if context.nil? || context.return_type.undefined?
         type.self_to(context.return_type.namespace)
       end
+
+      # @param type [ComplexType]
+      def maybe_nil type
+        return type if type.undefined? || type.void? || type.nullable?
+        return type unless nullable?
+        ComplexType.try_parse("#{type}, nil")
+      end
     end
   end
 end

data/lib/solargraph/source.rb

@@ -42,7 +42,6 @@ module Solargraph
       @version = version
       @domains = []
       begin
-        # @node, @comments = Source.parse_with_comments(@code, filename)
         @node, @comments = Solargraph::Parser.parse_with_comments(@code, filename)
         @parsed = true
       rescue Parser::SyntaxError, EncodingError => e
@@ -336,7 +335,6 @@ module Solargraph
     # @param parent [Symbol]
     # @return [void]
     def inner_folding_ranges top, result = [], parent = nil
-      # return unless top.is_a?(::Parser::AST::Node)
       return unless Parser.is_ast_node?(top)
       if FOLDING_NODE_TYPES.include?(top.type)
         # @todo Smelly exception for hash's first-level array in RubyVM
@@ -433,7 +431,6 @@ module Solargraph
     # @return [void]
     def inner_tree_at node, position, stack
       return if node.nil?
-      # here = Range.from_to(node.loc.expression.line, node.loc.expression.column, node.loc.expression.last_line, node.loc.expression.last_column)
       here = Range.from_node(node)
       if here.contain?(position) || colonized(here, position, node)
         stack.unshift node

data/lib/solargraph/source_map/clip.rb

@@ -53,11 +53,7 @@ module Solargraph
       #
       # @return [Array<Solargraph::Pin::Base>]
       def locals
-        loc_pos = context_pin.location.range.contain?(cursor.position) ? cursor.position : context_pin.location.range.ending
-        adj_pos = Position.new(loc_pos.line, (loc_pos.column.zero? ? 0 : loc_pos.column - 1))
-        @locals ||= source_map.locals.select { |pin|
-          pin.visible_from?(block, adj_pos)
-        }.reverse
+        @locals ||= source_map.locals_at(location)
       end
 
       def gates
@@ -92,6 +88,10 @@ module Solargraph
         @source_map ||= api_map.source_map(cursor.filename)
       end
 
+      def location
+        Location.new(source_map.filename, Solargraph::Range.new(cursor.position, cursor.position))
+      end
+
       # @return [Solargraph::Pin::Base]
       def block
         @block ||= source_map.locate_block_pin(cursor.node_position.line, cursor.node_position.character)

data/lib/solargraph/source_map/mapper.rb

@@ -61,7 +61,7 @@ module Solargraph
       end
 
       def process_comment source_position, comment_position, comment
-        return unless comment =~ MACRO_REGEXP
+        return unless comment.encode('UTF-8', invalid: :replace, replace: '?') =~ MACRO_REGEXP
         cmnt = remove_inline_comment_hashes(comment)
         parse = Solargraph::Source.parse_docstring(cmnt)
         last_line = 0
@@ -169,7 +169,7 @@ module Solargraph
             # @todo Handle parser errors in !parse directives
           end
         when 'domain'
-          namespace = closure_at(source_position)
+          namespace = closure_at(source_position) || Pin::ROOT_PIN
           namespace.domains.concat directive.tag.types unless directive.tag.types.nil?
         when 'override'
           pins.push Pin::Reference::Override.new(location, directive.tag.name, docstring.tags)
@@ -182,7 +182,7 @@ module Solargraph
         started = false
         comment.lines.each { |l|
           # Trim the comment and minimum leading whitespace
-          p = l.gsub(/^#/, '')
+          p = l.encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#/, '')
           if num.nil? && !p.strip.empty?
             num = p.index(/[^ ]/)
             started = true
@@ -197,7 +197,7 @@ module Solargraph
 
       # @return [void]
       def process_comment_directives
-        return unless @code =~ MACRO_REGEXP
+        return unless @code.encode('UTF-8', invalid: :replace, replace: '?') =~ MACRO_REGEXP
         code_lines = @code.lines
         @source.associated_comments.each do |line, comments|
           src_pos = line ? Position.new(line, code_lines[line].to_s.chomp.index(/[^\s]/) || 0) : Position.new(code_lines.length, 0)

data/lib/solargraph/version.rb

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

data/lib/solargraph/yard_map.rb

@@ -88,7 +88,7 @@ module Solargraph
       @rebindable_method_names ||= pins_by_class(Pin::Method)
         .select { |pin| pin.comments && pin.comments.include?('@yieldself') }
         .map(&:name)
-        .concat(['instance_eval', 'instance_exec', 'class_eval', 'class_exec', 'module_eval', 'module_exec'])
+        .concat(['instance_eval', 'instance_exec', 'class_eval', 'class_exec', 'module_eval', 'module_exec', 'define_method'])
         .to_set
     end
 

data/solargraph.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'tilt', '~> 2.0'
   s.add_runtime_dependency 'yard', '~> 0.9', '>= 0.9.24'
 
-  s.add_development_dependency 'pry', '~> 0.11.3'
+  s.add_development_dependency 'pry'
   s.add_development_dependency 'public_suffix', '~> 3.1'
   s.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
   s.add_development_dependency 'simplecov', '~> 0.14'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.44.0
+  version: 0.44.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -222,16 +222,16 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
@@ -510,6 +510,7 @@ files:
 - lib/solargraph/source/chain/link.rb
 - lib/solargraph/source/chain/literal.rb
 - lib/solargraph/source/chain/or.rb
+- lib/solargraph/source/chain/q_call.rb
 - lib/solargraph/source/chain/variable.rb
 - lib/solargraph/source/chain/z_super.rb
 - lib/solargraph/source/change.rb