Merge pull request #92 from r7kamura/feature/highlight-fix

Fix highlight about ivar, cvar, and gvar

lib/rucoa/handlers/text_document_document_highlight_handler.rb

@@ -298,7 +298,11 @@ def global_variable_scopable_node
 
           # @return [Enumerable<Rucoa::Nodes::Base>]
           def nodes
-            global_variable_scopable_node&.each_descendant(:gvar, :gvasgn) || []
+            return [] unless global_variable_scopable_node
+
+            global_variable_scopable_node.each_descendant(:gvar, :gvasgn).select do |node|
+              node.name == @node.name
+            end
           end
         end
 
@@ -319,12 +323,17 @@ def call
 
           # @return [Rucoa::Nodes::Base, nil]
           def instance_variable_scopable_node
-            @node.each_ancestor(:class, :module).first
+            @instance_variable_scopable_node ||= @node.each_ancestor(:class, :module).first
           end
 
+          # @todo Stop descendant searching if scope boundary node is found (e.g. class, def, etc.).
           # @return [Enumerable<Rucoa::Nodes::Base>]
           def nodes
-            instance_variable_scopable_node&.each_descendant(:ivar, :ivasgn) || []
+            return [] unless instance_variable_scopable_node
+
+            instance_variable_scopable_node.each_descendant(:ivar, :ivasgn).select do |node|
+              node.name == @node.name
+            end
           end
         end
 
@@ -350,7 +359,11 @@ def instance_variable_scopable_node
 
           # @return [Enumerable<Rucoa::Nodes::Base>]
           def nodes
-            instance_variable_scopable_node&.each_descendant(:cvar, :cvasgn) || []
+            return [] unless instance_variable_scopable_node
+
+            instance_variable_scopable_node.each_descendant(:cvar, :cvasgn).select do |node|
+              node.name == @node.name
+            end
           end
         end
 

lib/rucoa/node_concerns.rb

@@ -6,5 +6,6 @@ module NodeConcerns
     autoload :Modifier, 'rucoa/node_concerns/modifier'
     autoload :QualifiedName, 'rucoa/node_concerns/qualified_name'
     autoload :Rescue, 'rucoa/node_concerns/rescue'
+    autoload :Variable, 'rucoa/node_concerns/variable'
   end
 end

lib/rucoa/node_concerns/variable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module NodeConcerns
+    module Variable
+      # @return [String]
+      # @example returns variable name
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       foo = 1
+      #       foo
+      #     RUBY
+      #     uri: 'file:///path/to/example.rb'
+      #   ).node_at(
+      #     Rucoa::Position.new(
+      #       column: 0,
+      #       line: 2
+      #     )
+      #   )
+      #   expect(node.name).to eq('foo')
+      def name
+        children[0].to_s
+      end
+    end
+  end
+end

lib/rucoa/nodes/cvar_node.rb

@@ -3,6 +3,7 @@
 module Rucoa
   module Nodes
     class CvarNode < Base
+      include NodeConcerns::Variable
     end
   end
 end

lib/rucoa/nodes/cvasgn_node.rb

@@ -3,6 +3,7 @@
 module Rucoa
   module Nodes
     class CvasgnNode < Base
+      include NodeConcerns::Variable
     end
   end
 end

lib/rucoa/nodes/gvar_node.rb

@@ -3,6 +3,7 @@
 module Rucoa
   module Nodes
     class GvarNode < Base
+      include NodeConcerns::Variable
     end
   end
 end

lib/rucoa/nodes/gvasgn_node.rb

@@ -3,6 +3,7 @@
 module Rucoa
   module Nodes
     class GvasgnNode < Base
+      include NodeConcerns::Variable
     end
   end
 end

lib/rucoa/nodes/ivar_node.rb

@@ -3,6 +3,7 @@
 module Rucoa
   module Nodes
     class IvarNode < Base
+      include NodeConcerns::Variable
     end
   end
 end

lib/rucoa/nodes/ivasgn_node.rb

@@ -3,6 +3,7 @@
 module Rucoa
   module Nodes
     class IvasgnNode < Base
+      include NodeConcerns::Variable
     end
   end
 end

lib/rucoa/nodes/lvar_node.rb

@@ -3,24 +3,7 @@
 module Rucoa
   module Nodes
     class LvarNode < Base
-      # @return [String]
-      # @example returns local variable name
-      #   node = Rucoa::Source.new(
-      #     content: <<~RUBY,
-      #       foo = 1
-      #       foo
-      #     RUBY
-      #     uri: 'file:///path/to/example.rb'
-      #   ).node_at(
-      #     Rucoa::Position.new(
-      #       column: 2,
-      #       line: 2
-      #     )
-      #   )
-      #   expect(node.name).to eq('foo')
-      def name
-        children[0].to_s
-      end
+      include NodeConcerns::Variable
     end
   end
 end

lib/rucoa/nodes/lvasgn_node.rb

@@ -3,10 +3,7 @@
 module Rucoa
   module Nodes
     class LvasgnNode < Base
-      # @return [String]
-      def name
-        children[0].to_s
-      end
+      include NodeConcerns::Variable
     end
   end
 end

spec/rucoa/handlers/text_document_document_highlight_handler_spec.rb

@@ -858,6 +858,10 @@ def foo
             def bar
               @x ||= 2
             end
+
+            def baz
+              @y = 3
+            end
           end
 
           class B
@@ -905,6 +909,10 @@ def foo
             def bar
               @@x ||= 2
             end
+
+            def baz
+              @@y = 3
+            end
           end
 
           class B
@@ -952,6 +960,10 @@ def foo
             def bar
               $x ||= 2
             end
+
+            def baz
+              $y = 3
+            end
           end
 
           class B
@@ -1097,6 +1109,7 @@ def b
           def a
             foo = 1
             foo
+            baz
           end
 
           def b