rucoa 0.11.0 → 0.12.0

data/lib/rucoa/handlers/text_document_document_symbol_handler.rb

@@ -5,6 +5,8 @@ require 'set'
 module Rucoa
   module Handlers
     class TextDocumentDocumentSymbolHandler < Base
+      include HandlerConcerns::TextDocumentUriParameters
+
       DOCUMENT_SYMBOL_KIND_FOR_FILE = 1
       DOCUMENT_SYMBOL_KIND_FOR_MODULE = 2
       DOCUMENT_SYMBOL_KIND_FOR_NAMESPACE = 3
@@ -47,51 +49,6 @@ module Rucoa
 
       private
 
-      # @return [Array<Hash>]
-      def document_symbols
-        visit(source.root_node)
-        document_symbol_stack.first[:children]
-      end
-
-      # @param node [Rucoa::Nodes::Base]
-      # @return [void]
-      def visit(node)
-        document_symbols = create_document_symbols_for(node)
-        document_symbol_stack.last[:children].push(*document_symbols)
-        with_document_symbol_stack(document_symbols.first) do
-          with_singleton_class_stack(node) do
-            node.each_child_node do |child_node|
-              visit(child_node)
-            end
-          end
-        end
-      end
-
-      # @param document_symbol [Hash, nil]
-      # @return [void]
-      def with_document_symbol_stack(document_symbol)
-        unless document_symbol
-          yield
-          return
-        end
-
-        document_symbol_stack.push(document_symbol)
-        yield
-        document_symbol_stack.pop
-      end
-
-      # @param node [Rucoa::Nodes::Base]
-      def with_singleton_class_stack(node)
-        unless node.is_a?(Rucoa::Nodes::SclassNode)
-          yield
-          return
-        end
-
-        singleton_class_stack.push(node)
-        yield
-        singleton_class_stack.pop
-      end
-
       # @param node [Rucoa::Nodes::Base]
       # @return [Array<Hash>]
       def create_document_symbols_for(node)
@@ -102,8 +59,6 @@ module Rucoa
           create_document_symbols_for_class(node)
         when Nodes::DefNode
           create_document_symbols_for_def(node)
-        when Nodes::DefsNode
-          create_document_symbols_for_defs(node)
         when Nodes::ModuleNode
           create_document_symbols_for_module(node)
         when Nodes::SendNode
@@ -141,14 +96,14 @@ module Rucoa
         ]
       end
 
-      # @param node [Rucoa::Nodes::ModuleNode]
+      # @param node [Rucoa::Nodes::DefNode]
       # @return [Array<Hash>]
-      def create_document_symbols_for_module(node)
+      def create_document_symbols_for_def(node)
         [
           {
             children: [],
-            kind: DOCUMENT_SYMBOL_KIND_FOR_MODULE,
-            name: node.name,
+            kind: DOCUMENT_SYMBOL_KIND_FOR_METHOD,
+            name: "#{node.method_marker}#{node.name}",
             range: Range.from_parser_range(node.location.expression).to_vscode_range,
             selectionRange: Range.from_parser_range(node.location.name).to_vscode_range
           }
@@ -157,26 +112,26 @@ module Rucoa
 
       # @param node [Rucoa::Nodes::DefNode]
       # @return [Array<Hash>]
-      def create_document_symbols_for_def(node)
+      def create_document_symbols_for_defs(node)
         [
           {
             children: [],
             kind: DOCUMENT_SYMBOL_KIND_FOR_METHOD,
-            name: singleton_class_stack.empty? ? "##{node.name}" : ".#{node.name}",
+            name: ".#{node.name}",
             range: Range.from_parser_range(node.location.expression).to_vscode_range,
             selectionRange: Range.from_parser_range(node.location.name).to_vscode_range
           }
         ]
       end
 
-      # @param node [Rucoa::Nodes::DefNode]
+      # @param node [Rucoa::Nodes::ModuleNode]
       # @return [Array<Hash>]
-      def create_document_symbols_for_defs(node)
+      def create_document_symbols_for_module(node)
         [
           {
             children: [],
-            kind: DOCUMENT_SYMBOL_KIND_FOR_METHOD,
-            name: ".#{node.name}",
+            kind: DOCUMENT_SYMBOL_KIND_FOR_MODULE,
+            name: node.name,
             range: Range.from_parser_range(node.location.expression).to_vscode_range,
             selectionRange: Range.from_parser_range(node.location.name).to_vscode_range
           }
@@ -205,27 +160,17 @@ module Rucoa
         end
       end
 
-      # @return [Boolean]
-      def responsible?
-        configuration.enables_document_symbol? &&
-          !source.nil?
-      end
-
-      # @return [Rucoa::Source]
-      def source
-        @source ||= source_store.get(uri)
-      end
-
-      # @return [String]
-      def uri
-        request.dig('params', 'textDocument', 'uri')
-      end
-
       # @return [Arrah<Hash>]
       def document_symbol_stack
         @document_symbol_stack ||= [dummy_document_symbol]
       end
 
+      # @return [Array<Hash>]
+      def document_symbols
+        visit(source.root_node)
+        document_symbol_stack.first[:children]
+      end
+
       # @return [Hash]
       def dummy_document_symbol
         {
@@ -233,9 +178,35 @@ module Rucoa
         }
       end
 
-      # @return [Array<Rucoa::Nodes::SclassNode>]
-      def singleton_class_stack
-        @singleton_class_stack ||= []
+      # @return [Boolean]
+      def responsible?
+        configuration.enables_document_symbol? &&
+          !source.nil?
+      end
+
+      # @param node [Rucoa::Nodes::Base]
+      # @return [void]
+      def visit(node)
+        document_symbols = create_document_symbols_for(node)
+        document_symbol_stack.last[:children].push(*document_symbols)
+        with_document_symbol_stack(document_symbols.first) do
+          node.each_child_node do |child_node|
+            visit(child_node)
+          end
+        end
+      end
+
+      # @param document_symbol [Hash, nil]
+      # @return [void]
+      def with_document_symbol_stack(document_symbol)
+        unless document_symbol
+          yield
+          return
+        end
+
+        document_symbol_stack.push(document_symbol)
+        yield
+        document_symbol_stack.pop
       end
     end
   end

data/lib/rucoa/handlers/text_document_formatting_handler.rb

@@ -3,19 +3,14 @@
 module Rucoa
   module Handlers
     class TextDocumentFormattingHandler < Base
+      include HandlerConcerns::TextDocumentUriParameters
+
       def call
         respond(edits)
       end
 
       private
 
-      # @return [Boolean]
-      def formattable?
-        configuration.enables_formatting? &&
-          source &&
-          Rubocop::ConfigurationChecker.call
-      end
-
       # @return [Array<Hash>]
       def edits
         return [] unless formattable?
@@ -23,22 +18,11 @@ module Rucoa
         [text_edit]
       end
 
-      # @return [Rucoa::Source, nil]
-      def source
-        @source ||= source_store.get(uri)
-      end
-
-      # @return [String]
-      def uri
-        request.dig('params', 'textDocument', 'uri')
-      end
-
-      # @return [Hash]
-      def text_edit
-        {
-          newText: new_text,
-          range: range
-        }
+      # @return [Boolean]
+      def formattable?
+        configuration.enables_formatting? &&
+          source &&
+          Rubocop::ConfigurationChecker.call
       end
 
       # @return [String]
@@ -59,6 +43,14 @@ module Rucoa
           )
         ).to_vscode_range
       end
+
+      # @return [Hash]
+      def text_edit
+        {
+          newText: new_text,
+          range: range
+        }
+      end
     end
   end
 end

data/lib/rucoa/handlers/text_document_hover_handler.rb

@@ -3,28 +3,15 @@
 module Rucoa
   module Handlers
     class TextDocumentHoverHandler < Base
+      include HandlerConcerns::TextDocumentPositionParameters
+      include HandlerConcerns::TextDocumentUriParameters
+
       def call
         respond(hover)
       end
 
       private
 
-      # @return [Hash, nil]
-      def hover
-        return unless responsible?
-
-        {
-          contents: contents,
-          range: range.to_vscode_range
-        }
-      end
-
-      # @return [Boolean]
-      def responsible?
-        configuration.enables_hover? &&
-          !contents.nil?
-      end
-
       # @return [String, nil]
       def contents
         @contents ||=
@@ -42,33 +29,6 @@ module Rucoa
           end
       end
 
-      # @return [Rucoa::Range]
-      def range
-        Range.from_parser_range(node.location.expression)
-      end
-
-      # @return [Rucoa::Nodes::Base, nil]
-      def node
-        @node ||= source&.node_at(position)
-      end
-
-      # @return [Rucoa::Source, nil]
-      def source
-        @source ||= source_store.get(uri)
-      end
-
-      # @return [String]
-      def uri
-        request.dig('params', 'textDocument', 'uri')
-      end
-
-      # @return [Rucoa::Position]
-      def position
-        Position.from_vscode_position(
-          request.dig('params', 'position')
-        )
-      end
-
       # @return [Rucoa::Definitions::Base, nil]
       def definition
         return unless node
@@ -78,6 +38,27 @@ module Rucoa
           node: node
         ).definitions.first
       end
+
+      # @return [Hash, nil]
+      def hover
+        return unless responsible?
+
+        {
+          contents: contents,
+          range: range.to_vscode_range
+        }
+      end
+
+      # @return [Rucoa::Range]
+      def range
+        Range.from_parser_range(node.location.expression)
+      end
+
+      # @return [Boolean]
+      def responsible?
+        configuration.enables_hover? &&
+          !contents.nil?
+      end
     end
   end
 end

data/lib/rucoa/handlers/text_document_range_formatting_handler.rb

@@ -3,12 +3,26 @@
 module Rucoa
   module Handlers
     class TextDocumentRangeFormattingHandler < Base
+      include HandlerConcerns::TextDocumentUriParameters
+
       def call
         respond(edits)
       end
 
       private
 
+      # @return [Array<RuboCop::Cop::Corrector>]
+      def correctable_offenses
+        offenses.select(&:corrector)
+      end
+
+      # @return [Array(Rucoa::Range, String)]
+      def correctable_replacements
+        replacements.select do |replacement_range, _|
+          range.contain?(replacement_range)
+        end
+      end
+
       # @return [Array<Hash>]
       def edits
         return [] unless formattable?
@@ -28,14 +42,9 @@ module Rucoa
           Rubocop::ConfigurationChecker.call
       end
 
-      # @return [Rucoa::Source]
-      def source
-        @source ||= source_store.get(uri)
-      end
-
-      # @return [String]
-      def uri
-        request.dig('params', 'textDocument', 'uri')
+      # @return [Array<RuboCop::Cop::Offense>]
+      def offenses
+        Rubocop::Investigator.call(source: source)
       end
 
       # @return [Rucoa::Range]
@@ -45,23 +54,6 @@ module Rucoa
         )
       end
 
-      # @return [Array<RuboCop::Cop::Corrector>]
-      def correctable_offenses
-        offenses.select(&:corrector)
-      end
-
-      # @return [Array(Rucoa::Range, String)]
-      def correctable_replacements
-        replacements.select do |replacement_range, _|
-          range.contain?(replacement_range)
-        end
-      end
-
-      # @return [Array<RuboCop::Cop::Offense>]
-      def offenses
-        Rubocop::Investigator.call(source: source)
-      end
-
       # @return [Array(Rucoa::Range, String)]
       def replacements
         correctable_offenses.map(&:corrector).flat_map(&:as_replacements).map do |replacement_range, replacement|

data/lib/rucoa/handlers/text_document_selection_range_handler.rb

@@ -3,6 +3,8 @@
 module Rucoa
   module Handlers
     class TextDocumentSelectionRangeHandler < Base
+      include HandlerConcerns::TextDocumentUriParameters
+
       def call
         return unless responsible?
 
@@ -18,17 +20,6 @@ module Rucoa
 
       private
 
-      # @return [Boolean]
-      def responsible?
-        configuration.enables_selection_range? &&
-          !source.nil?
-      end
-
-      # @return [Rucoa::Source]
-      def source
-        @source ||= source_store.get(uri)
-      end
-
       # @return [Array<Rucoa::Position>]
       def positions
         request.dig('params', 'positions').map do |position|
@@ -36,9 +27,10 @@ module Rucoa
         end
       end
 
-      # @return [String]
-      def uri
-        request.dig('params', 'textDocument', 'uri')
+      # @return [Boolean]
+      def responsible?
+        configuration.enables_selection_range? &&
+          !source.nil?
       end
 
       class SelectionRangeProvider
@@ -128,6 +120,11 @@ module Rucoa
 
           private
 
+          # @return [Rucoa::Range]
+          def expression_range
+            Range.from_parser_range(@node.location.expression)
+          end
+
           # @return [Rucoa::Range]
           def inner_range
             Range.new(
@@ -135,11 +132,6 @@ module Rucoa
               Position.from_parser_range_beginning(@node.location.end)
             )
           end
-
-          # @return [Rucoa::Range]
-          def expression_range
-            Range.from_parser_range(@node.location.expression)
-          end
         end
       end
     end

data/lib/rucoa/handlers/text_document_signature_help_handler.rb

@@ -3,12 +3,29 @@
 module Rucoa
   module Handlers
     class TextDocumentSignatureHelpHandler < Base
+      include HandlerConcerns::TextDocumentPositionParameters
+      include HandlerConcerns::TextDocumentUriParameters
+
       def call
         respond(signature_help)
       end
 
       private
 
+      # @return [Array<Rucoa::Definitions::MethodDefinition>]
+      def method_definitions
+        NodeInspector.new(
+          definition_store: definition_store,
+          node: node
+        ).method_definitions
+      end
+
+      # @return [Boolean]
+      def responsible?
+        configuration.enables_signature_help? &&
+          node.is_a?(Nodes::SendNode)
+      end
+
       # @return [Hash]
       def signature_help
         return unless responsible?
@@ -18,12 +35,6 @@ module Rucoa
         }
       end
 
-      # @return [Boolean]
-      def responsible?
-        configuration.enables_signature_help? &&
-          node.is_a?(Nodes::SendNode)
-      end
-
       # @return [Array<Hash>]
       def signature_informations
         method_definitions.map do |method_definition|
@@ -33,36 +44,6 @@ module Rucoa
           }
         end
       end
-
-      # @return [Array<Rucoa::Definitions::MethodDefinition>]
-      def method_definitions
-        NodeInspector.new(
-          definition_store: definition_store,
-          node: node
-        ).method_definitions
-      end
-
-      # @return [Rucoa::Nodes::Base, nil]
-      def node
-        @node ||= source.node_at(position)
-      end
-
-      # @return [Rucoa::Position]
-      def position
-        Position.from_vscode_position(
-          request.dig('params', 'position')
-        )
-      end
-
-      # @return [Rucoa::Source]
-      def source
-        source_store.get(uri)
-      end
-
-      # @return [String]
-      def uri
-        request.dig('params', 'textDocument', 'uri')
-      end
     end
   end
 end

data/lib/rucoa/handlers.rb

@@ -13,6 +13,7 @@ module Rucoa
     autoload :TextDocumentDidChangeHandler, 'rucoa/handlers/text_document_did_change_handler'
     autoload :TextDocumentDidCloseHandler, 'rucoa/handlers/text_document_did_close_handler'
     autoload :TextDocumentDidOpenHandler, 'rucoa/handlers/text_document_did_open_handler'
+    autoload :TextDocumentDocumentHighlightHandler, 'rucoa/handlers/text_document_document_highlight_handler'
     autoload :TextDocumentDocumentSymbolHandler, 'rucoa/handlers/text_document_document_symbol_handler'
     autoload :TextDocumentFormattingHandler, 'rucoa/handlers/text_document_formatting_handler'
     autoload :TextDocumentHoverHandler, 'rucoa/handlers/text_document_hover_handler'

data/lib/rucoa/node_concerns/body.rb

@@ -5,7 +5,7 @@ module Rucoa
     module Body
       # @return [Rucoa::Nodes::BeginNode, nil]
       def body
-        children[2]
+        children.last
       end
 
       # @return [Array<Rucoa::Nodes::Base>]

data/lib/rucoa/node_concerns/qualified_name.rb

@@ -3,6 +3,11 @@
 module Rucoa
   module NodeConcerns
     module QualifiedName
+      # @return [String]
+      def name
+        raise NotImplementedError
+      end
+
       # @return [String]
       def qualified_name
         [
@@ -10,11 +15,6 @@ module Rucoa
           *each_ancestor(:class, :constant, :module).map(&:name)
         ].reverse.join('::')
       end
-
-      # @return [String]
-      def name
-        raise NotImplementedError
-      end
     end
   end
 end

data/lib/rucoa/node_concerns/rescue.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module NodeConcerns
+    module Rescue
+      # @return [Rucoa::Nodes::EnsureNode, nil]
+      def ensure
+        return unless body.is_a?(Nodes::EnsureNode)
+
+        body
+      end
+
+      # @return [Rucoa::Nodes::RescueNode, nil]
+      def rescue
+        return unless body.is_a?(Nodes::RescueNode)
+
+        body
+      end
+    end
+  end
+end

data/lib/rucoa/node_concerns.rb

@@ -4,5 +4,6 @@ module Rucoa
   module NodeConcerns
     autoload :Body, 'rucoa/node_concerns/body'
     autoload :QualifiedName, 'rucoa/node_concerns/qualified_name'
+    autoload :Rescue, 'rucoa/node_concerns/rescue'
   end
 end

data/lib/rucoa/node_inspector.rb

@@ -103,11 +103,6 @@ module Rucoa
       )
     end
 
-    # @return [Boolean]
-    def singleton_method_call?
-      @node.is_a?(Nodes::ConstNode)
-    end
-
     # @return [String, nil]
     def nearest_def_qualified_name
       @node.each_ancestor(:def).first&.qualified_name
@@ -147,5 +142,10 @@ module Rucoa
         )&.return_types
       end.compact
     end
+
+    # @return [Boolean]
+    def singleton_method_call?
+      @node.is_a?(Nodes::ConstNode)
+    end
   end
 end