rucoa 0.10.0 → 0.12.0

data/lib/rucoa/handlers/text_document_document_highlight_handler.rb

@@ -0,0 +1,256 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class TextDocumentDocumentHighlightHandler < Base
+      include HandlerConcerns::TextDocumentPositionParameters
+      include HandlerConcerns::TextDocumentUriParameters
+
+      DOCUMENT_HIGHLIGHT_KIND_READ = 2
+      DOCUMENT_HIGHLIGHT_KIND_TEXT = 1
+      DOCUMENT_HIGHLIGHT_KIND_WRITE = 3
+
+      # @return [void]
+      def call
+        respond(document_highlights)
+      end
+
+      private
+
+      # @return [Array<Hash>]
+      def document_highlights
+        parser_ranges.map do |parser_range|
+          {
+            'kind' => DOCUMENT_HIGHLIGHT_KIND_TEXT,
+            'range' => Range.from_parser_range(parser_range).to_vscode_range
+          }
+        end
+      end
+
+      # @return [Array<Parser::Source::Range>]
+      def parser_ranges
+        return [] unless reponsible?
+
+        NodeToRangesMappers::AnyMapper.call(node)
+      end
+
+      # @return [Boolean]
+      def reponsible?
+        configuration.enables_highlight?
+      end
+
+      module NodeToRangesMappers
+        class Base
+          class << self
+            # @param node [Rucoa::Nodes::Base]
+            # @return [Array<Parser::Source::Range>]
+            def call(node)
+              new(node).call
+            end
+          end
+
+          # @param node [Rucoa::Nodes::Base]
+          def initialize(node)
+            @node = node
+          end
+
+          # @return [Array<Parser::Source::Range>]
+          def call
+            raise ::NotImplementedError
+          end
+        end
+
+        class AnyMapper < Base
+          # @return [Array<Parser::Source::Range>]
+          def call
+            case @node
+            when Nodes::BeginNode, Nodes::BlockNode
+              BeginMapper.call(@node)
+            when Nodes::CaseNode
+              CaseMapper.call(@node)
+            when Nodes::ClassNode, Nodes::ModuleNode
+              ModuleMapper.call(@node)
+            when Nodes::DefNode
+              DefMapper.call(@node)
+            when Nodes::EnsureNode, Nodes::ResbodyNode, Nodes::RescueNode, Nodes::WhenNode
+              AnyMapper.call(@node.parent)
+            when Nodes::ForNode
+              ForMapper.call(@node)
+            when Nodes::IfNode
+              IfMapper.call(@node)
+            when Nodes::SendNode
+              SendMapper.call(@node)
+            when Nodes::UntilNode, Nodes::WhileNode
+              WhileMapper.call(@node)
+            else
+              []
+            end
+          end
+        end
+
+        class BeginMapper < Base
+          # @return [Array<Parser::Source::Range>]
+          def call
+            [
+              range_begin,
+              *ranges_resbody,
+              range_else,
+              range_ensure,
+              range_end
+            ].compact
+          end
+
+          private
+
+          # @return [Parser::Source::Range]
+          def range_begin
+            @node.location.begin
+          end
+
+          # @return [Parser::Source::Range, nil]
+          def range_else
+            return unless rescue_node
+
+            rescue_node.location.else
+          end
+
+          # @return [Parser::Source::Range]
+          def range_end
+            @node.location.end
+          end
+
+          # @return [Parser::Source::Range]
+          def range_ensure
+            return unless @node.ensure
+
+            @node.ensure.location.keyword
+          end
+
+          # @return [Array<Parser::Source::Range>]
+          def ranges_resbody
+            return [] unless rescue_node
+
+            rescue_node.resbodies.map do |resbody|
+              resbody.location.keyword
+            end
+          end
+
+          # @return [Rucoa::Nodes::RescueNode, nil]
+          def rescue_node
+            @rescue_node ||= @node.rescue || @node.ensure&.rescue
+          end
+        end
+
+        class DefMapper < BeginMapper
+          private
+
+          # @return [Parser::Source::Range]
+          def range_begin
+            @node.location.keyword
+          end
+        end
+
+        class CaseMapper < Base
+          # @return [Array<Parser::Source::Range>]
+          def call
+            [
+              @node.location.keyword,
+              *ranges_when,
+              @node.location.else,
+              @node.location.end
+            ].compact
+          end
+
+          private
+
+          # @return [Array<Parser::Source::Range>]
+          def ranges_when
+            @node.whens.map do |when_node|
+              when_node.location.keyword
+            end
+          end
+        end
+
+        class IfMapper < Base
+          # @return [Array<Parser::Source::Range>]
+          def call
+            return AnyMapper.call(@node.parent) if @node.elsif?
+
+            [
+              @node.location.keyword,
+              *ranges_elsif,
+              @node.location.else,
+              @node.location.end
+            ].compact
+          end
+
+          private
+
+          # @return [Array<Parser::Source::Range>]
+          def ranges_elsif
+            return [] unless @node.elsif
+
+            ElsifMapper.call(@node.elsif)
+          end
+        end
+
+        class ElsifMapper < IfMapper
+          # @return [Array<Parser::Source::Range>]
+          def call
+            [
+              *ranges_elsif,
+              @node.location.else
+            ].compact
+          end
+        end
+
+        class ForMapper < Base
+          # @return [Array<Parser::Source::Range>]
+          def call
+            [
+              @node.location.keyword,
+              @node.location.in,
+              @node.location.end
+            ].compact
+          end
+        end
+
+        class ModuleMapper < Base
+          # @return [Array<Parser::Source::Range>]
+          def call
+            [
+              @node.location.keyword,
+              @node.location.end
+            ]
+          end
+        end
+
+        class SendMapper < Base
+          # @return [Array<Parser::Source::Range>]
+          def call
+            return [] unless @node.block
+
+            BeginMapper.call(@node.block)
+          end
+        end
+
+        class WhenMapper < Base
+          # @return [Array<Parser::Source::Range>]
+          def call
+            CaseMapper.call(@node.parent)
+          end
+        end
+
+        class WhileMapper < Base
+          # @return [Array<Parser::Source::Range>]
+          def call
+            [
+              @node.location.keyword,
+              @node.location.end
+            ]
+          end
+        end
+      end
+    end
+  end
+end

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|