rucoa 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cec8d0284ecf97b03cd43de02d36c16263910dba3c5a1052f73df0bf0fd51f68
-  data.tar.gz: b83c8aad102fbd510a0f7474394ab8cf91cd17976bbc365e188c276789815e9a
+  metadata.gz: 3829019e74a6fedcb5548ce3630b3c145c12ab40c0df99b63fd9747975f0a71d
+  data.tar.gz: 4cd7373ed7239adeb955caf7c373fe5da6d90ca0d92dc34801d2179db0387bbf
 SHA512:
-  metadata.gz: 3042168fc7a78f71854f96d8367f9f4e1e0c62d4300b4feef36b6596e602b3c40c5150d1d6f0902ab5d7b1015179cdf10c2d1e6beabe68cbf3fa1114f6cdb00e
-  data.tar.gz: 6721bdccd41cb883d6b6ab97a5a990b878e088a7832ccb6c42bcc642ff13f1ab3126d8893a43b47a29295caa0ff14ed4b59bdf5ab0ca95c14a4536dee11eb899
+  metadata.gz: a3bbe0f9cb45652ab45706b3afa87853ba3e4d8e33b5894080772a054463bc3828db454da0a0af292982f4de9b8fa18a0353d1cf527e6961455d08c68eeeae63
+  data.tar.gz: 3b23e8f98a5a57a7f236f22ba7e8e606a43f477e789646740a99cdbb30f0bf5adb21779c1ea2e0f828112e32e4dd242eae28fde14120870d8163f0bc1adbc769

data/.rubocop.yml

@@ -8,6 +8,9 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.7
 
+Gemspec/RequireMFA:
+  Enabled: false
+
 Layout/LineLength:
   Enabled: false
 
@@ -35,13 +38,19 @@ Security/MarshalLoad:
 Sevencop/AutoloadOrdered:
   Enabled: true
 
-Sevencop/HashLiteralOrder:
+Sevencop/HashElementOrdered:
+  Enabled: true
+
+Sevencop/MethodDefinitionOrdered:
+  Enabled: true
+
+Sevencop/MethodDefinitionArgumentsMultiline:
   Enabled: true
 
-Sevencop/MethodDefinitionKeywordArgumentsOrdered:
+Sevencop/MethodDefinitionKeywordArgumentOrdered:
   Enabled: true
 
-Sevencop/MethodDefinitionMultilineArguments:
+Sevencop/RequireOrdered:
   Enabled: true
 
 Style/Documentation:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rucoa (0.11.0)
+    rucoa (0.13.0)
       parser
       rbs
       rubocop
@@ -19,7 +19,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     rbs (2.6.0)
-    regexp_parser (2.5.0)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -54,7 +54,7 @@ GEM
     rubocop-rspec (2.13.2)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
-    sevencop (0.13.0)
+    sevencop (0.16.0)
       rubocop
     unicode-display_width (2.3.0)
     webrick (1.7.0)

data/README.md

@@ -35,6 +35,12 @@ Run "Format Document" command or enable "Format On Save" in the settings to auto
 
 ![demo](images/document-formatting.gif)
 
+### Highlight
+
+Highlights corresponding keywords.
+
+![demo](images/document-highlight.gif)
+
 ### Selection
 
 Run "Expand Selection" command to select appropriate ranges.
@@ -76,5 +82,4 @@ Shows method signature help when you start to type method arguments like `"100".
 
 ## Coming soon
 
-- Highlight
 - Semantic Tokens

data/lib/rucoa/configuration.rb

@@ -36,6 +36,11 @@ module Rucoa
       disable_feature('formatting')
     end
 
+    # @return [void]
+    def disable_highlight
+      disable_feature('highlight')
+    end
+
     # @return [void]
     def disable_hover
       disable_feature('hover')
@@ -58,18 +63,6 @@ module Rucoa
       @settings['base']['debug'] = true
     end
 
-    # @return [Boolean]
-    # @example returns false if the configuration is empty
-    #   configuration = Rucoa::Configuration.new
-    #   expect(configuration).not_to be_enables_debug
-    # @example returns true if the configuration enables debug
-    #   configuration = Rucoa::Configuration.new
-    #   configuration.update('base' => { 'debug' => true })
-    #   expect(configuration).to be_enables_debug
-    def enables_debug?
-      fetch('base', 'debug', default: false)
-    end
-
     # @return [Boolean]
     # @example returns true if the configuration is empty
     #   configuration = Rucoa::Configuration.new
@@ -87,6 +80,18 @@ module Rucoa
       enables_feature?('completion')
     end
 
+    # @return [Boolean]
+    # @example returns false if the configuration is empty
+    #   configuration = Rucoa::Configuration.new
+    #   expect(configuration).not_to be_enables_debug
+    # @example returns true if the configuration enables debug
+    #   configuration = Rucoa::Configuration.new
+    #   configuration.update('base' => { 'debug' => true })
+    #   expect(configuration).to be_enables_debug
+    def enables_debug?
+      fetch('base', 'debug', default: false)
+    end
+
     # @return [Boolean]
     def enables_definition?
       enables_feature?('definition')
@@ -107,6 +112,11 @@ module Rucoa
       enables_feature?('formatting')
     end
 
+    # @return [Boolean]
+    def enables_highlight?
+      enables_feature?('highlight')
+    end
+
     # @return [Boolean]
     def enables_hover?
       enables_feature?('hover')

data/lib/rucoa/definition_store.rb

@@ -7,11 +7,6 @@ module Rucoa
       @qualified_names_by_uri = ::Hash.new { |hash, key| hash[key] = [] }
     end
 
-    # @return [String]
-    def inspect
-      "#<#{self.class} definitions_count=#{@definition_by_qualified_name.count}>"
-    end
-
     # @param definitions [Array<Rucoa::Definition::Base>]
     # @return [void]
     def bulk_add(definitions)
@@ -23,61 +18,12 @@ module Rucoa
       end
     end
 
-    # @param source [Rucoa::Source]
-    # @return [void]
-    # @example resolves super class name from definitions
-    #   definition_store = Rucoa::DefinitionStore.new
-    #   foo = Rucoa::Source.new(
-    #     content: <<~RUBY,
-    #       module A
-    #         class Foo
-    #         end
-    #       end
-    #     RUBY
-    #     uri: 'file:///path/to/a/foo.rb',
-    #   )
-    #   definition_store.update_from(foo)
-    #   bar = Rucoa::Source.new(
-    #     content: <<~RUBY,
-    #       module A
-    #         class Bar < Foo
-    #         end
-    #       end
-    #     RUBY
-    #     uri: 'file:///path/to/a/bar.rb',
-    #   )
-    #   definition_store.update_from(bar)
-    #   definition = definition_store.find_definition_by_qualified_name('A::Bar')
-    #   expect(definition.super_class_qualified_name).to eq('A::Foo')
-    # @example resolves included module names from definitions
-    #   definition_store = Rucoa::DefinitionStore.new
-    #   foo = Rucoa::Source.new(
-    #     content: <<~RUBY,
-    #       module A
-    #         module Foo
-    #         end
-    #       end
-    #     RUBY
-    #     uri: 'file:///path/to/a/foo.rb',
-    #   )
-    #   definition_store.update_from(foo)
-    #   bar = Rucoa::Source.new(
-    #     content: <<~RUBY,
-    #       module A
-    #         class Bar
-    #           include Foo
-    #         end
-    #       end
-    #     RUBY
-    #     uri: 'file:///path/to/a/bar.rb',
-    #   )
-    #   definition_store.update_from(bar)
-    #   definition = definition_store.find_definition_by_qualified_name('A::Bar')
-    #   expect(definition.included_module_qualified_names).to eq(%w[A::Foo])
-    def update_from(source)
-      delete_definitions_in(source)
-      add_definitions_in(source)
-      resolve_constants_in(source)
+    # @param namespace [String]
+    # @return [Array<Rucoa::Definitions::ConstantDefinition>] e.g. File::Separator, File::SEPARATOR, etc.
+    def constant_definitions_under(namespace)
+      constant_definitions.select do |constant_definition|
+        constant_definition.namespace == namespace
+      end
     end
 
     # @param qualified_name [String]
@@ -178,6 +124,11 @@ module Rucoa
       end
     end
 
+    # @return [String]
+    def inspect
+      "#<#{self.class} definitions_count=#{@definition_by_qualified_name.count}>"
+    end
+
     # @param type [String]
     # @return [Array<Rucoa::Definitions::MethodDefinition>]
     # @example supports simple instance method
@@ -266,6 +217,19 @@ module Rucoa
       end.uniq(&:method_name)
     end
 
+    # @todo Search ancestors.
+    # @param unqualified_name [Rucoa::UnqualifiedName]
+    # @return [String]
+    def resolve_constant(unqualified_name)
+      (
+        unqualified_name.module_nesting.map do |prefix|
+          "#{prefix}::#{unqualified_name.chained_name}"
+        end + [unqualified_name.chained_name]
+      ).find do |candidate|
+        find_definition_by_qualified_name(candidate)
+      end || unqualified_name.chained_name
+    end
+
     # @param type [String]
     # @return [Array<Rucoa::Definitions::MethodDefinition>]
     # @example supports simple singleton method
@@ -340,42 +304,76 @@ module Rucoa
       end.uniq(&:method_name)
     end
 
-    # @param namespace [String]
-    # @return [Array<Rucoa::Definitions::ConstantDefinition>] e.g. File::Separator, File::SEPARATOR, etc.
-    def constant_definitions_under(namespace)
-      constant_definitions.select do |constant_definition|
-        constant_definition.namespace == namespace
-      end
-    end
-
-    # @todo Search ancestors.
-    # @param unqualified_name [Rucoa::UnqualifiedName]
-    # @return [String]
-    def resolve_constant(unqualified_name)
-      (
-        unqualified_name.module_nesting.map do |prefix|
-          "#{prefix}::#{unqualified_name.chained_name}"
-        end + [unqualified_name.chained_name]
-      ).find do |candidate|
-        find_definition_by_qualified_name(candidate)
-      end || unqualified_name.chained_name
+    # @param source [Rucoa::Source]
+    # @return [void]
+    # @example resolves super class name from definitions
+    #   definition_store = Rucoa::DefinitionStore.new
+    #   foo = Rucoa::Source.new(
+    #     content: <<~RUBY,
+    #       module A
+    #         class Foo
+    #         end
+    #       end
+    #     RUBY
+    #     uri: 'file:///path/to/a/foo.rb',
+    #   )
+    #   definition_store.update_from(foo)
+    #   bar = Rucoa::Source.new(
+    #     content: <<~RUBY,
+    #       module A
+    #         class Bar < Foo
+    #         end
+    #       end
+    #     RUBY
+    #     uri: 'file:///path/to/a/bar.rb',
+    #   )
+    #   definition_store.update_from(bar)
+    #   definition = definition_store.find_definition_by_qualified_name('A::Bar')
+    #   expect(definition.super_class_qualified_name).to eq('A::Foo')
+    # @example resolves included module names from definitions
+    #   definition_store = Rucoa::DefinitionStore.new
+    #   foo = Rucoa::Source.new(
+    #     content: <<~RUBY,
+    #       module A
+    #         module Foo
+    #         end
+    #       end
+    #     RUBY
+    #     uri: 'file:///path/to/a/foo.rb',
+    #   )
+    #   definition_store.update_from(foo)
+    #   bar = Rucoa::Source.new(
+    #     content: <<~RUBY,
+    #       module A
+    #         class Bar
+    #           include Foo
+    #         end
+    #       end
+    #     RUBY
+    #     uri: 'file:///path/to/a/bar.rb',
+    #   )
+    #   definition_store.update_from(bar)
+    #   definition = definition_store.find_definition_by_qualified_name('A::Bar')
+    #   expect(definition.included_module_qualified_names).to eq(%w[A::Foo])
+    def update_from(source)
+      delete_definitions_in(source)
+      add_definitions_in(source)
+      resolve_constants_in(source)
     end
 
     private
 
     # @param source [Rucoa::Source]
     # @return [void]
-    def delete_definitions_in(source)
-      @qualified_names_by_uri[source.uri].each do |qualified_name|
-        @definition_by_qualified_name.delete(qualified_name)
+    def add_definitions_in(source)
+      source.definitions.group_by do |definition|
+        definition.location.uri
+      end.each do |uri, definitions|
+        @qualified_names_by_uri[uri] += definitions.map(&:qualified_name)
+        definitions.each do |definition|
+          @definition_by_qualified_name[definition.qualified_name] = definition
+        end
       end
-      @qualified_names_by_uri.delete(source.uri)
-    end
-
-    # @param type [String]
-    # @return [String, nil]
-    def singleton_class_name_from(type)
-      type[/singleton<([\w:]+)>/, 1]
     end
 
     # @param definition [Rucoa::Definitions::Class, Rucoa::Definitions::Module]
@@ -390,32 +388,9 @@ module Rucoa
       end
     end
 
-    # @param definition [Rucoa::Definitions::Class, Rucoa::Definitions::Module]
-    # @return [Array<Rucoa::Definitions::Class, Rucoa::Definitions::Module>] An array of prepended, itself, and included definitions
-    def module_ancestors_of(definition)
-      [
-        *definition.prepended_module_qualified_names.filter_map do |qualified_name|
-          find_definition_by_qualified_name(qualified_name)
-        end.reverse,
-        definition,
-        *definition.included_module_qualified_names.filter_map do |qualified_name|
-          find_definition_by_qualified_name(qualified_name)
-        end.reverse
-      ]
-    end
-
-    # @param definition [Rucoa::Definitions::Class]
-    # @return [Array<Rucoa::Definitions::Class>] super "class"es (not including modules) in closest-first order
-    def super_class_definitions_of(definition)
-      result = []
-      while (super_class_qualified_name = definition.super_class_qualified_name)
-        super_definition = find_definition_by_qualified_name(super_class_qualified_name)
-        break unless super_definition
-
-        result << super_definition
-        definition = super_definition
-      end
-      result
+    # @return [Array<Rucoa::Definition::ConstantDefinition>]
+    def constant_definitions
+      definitions.grep(Definitions::ConstantDefinition)
     end
 
     # @return [Array<Rucoa::Definitions::Base>]
@@ -423,27 +398,32 @@ module Rucoa
       @definition_by_qualified_name.values
     end
 
+    # @param source [Rucoa::Source]
+    # @return [void]
+    def delete_definitions_in(source)
+      @qualified_names_by_uri[source.uri].each do |qualified_name|
+        @definition_by_qualified_name.delete(qualified_name)
+      end
+      @qualified_names_by_uri.delete(source.uri)
+    end
+
     # @return [Array<Rucoa::Definition::MethodDefinition>]
     def method_definitions
       definitions.grep(Definitions::MethodDefinition)
     end
 
-    # @return [Array<Rucoa::Definition::ConstantDefinition>]
-    def constant_definitions
-      definitions.grep(Definitions::ConstantDefinition)
-    end
-
-    # @param source [Rucoa::Source]
-    # @return [void]
-    def add_definitions_in(source)
-      source.definitions.group_by do |definition|
-        definition.location.uri
-      end.each do |uri, definitions|
-        @qualified_names_by_uri[uri] += definitions.map(&:qualified_name)
-        definitions.each do |definition|
-          @definition_by_qualified_name[definition.qualified_name] = definition
-        end
-      end
+    # @param definition [Rucoa::Definitions::Class, Rucoa::Definitions::Module]
+    # @return [Array<Rucoa::Definitions::Class, Rucoa::Definitions::Module>] An array of prepended, itself, and included definitions
+    def module_ancestors_of(definition)
+      [
+        *definition.prepended_module_qualified_names.filter_map do |qualified_name|
+          find_definition_by_qualified_name(qualified_name)
+        end.reverse,
+        definition,
+        *definition.included_module_qualified_names.filter_map do |qualified_name|
+          find_definition_by_qualified_name(qualified_name)
+        end.reverse
+      ]
     end
 
     # @param source [Rucoa::Source]
@@ -471,5 +451,25 @@ module Rucoa
         definition.prepended_module_unqualified_names = []
       end
     end
+
+    # @param type [String]
+    # @return [String, nil]
+    def singleton_class_name_from(type)
+      type[/singleton<([\w:]+)>/, 1]
+    end
+
+    # @param definition [Rucoa::Definitions::Class]
+    # @return [Array<Rucoa::Definitions::Class>] super "class"es (not including modules) in closest-first order
+    def super_class_definitions_of(definition)
+      result = []
+      while (super_class_qualified_name = definition.super_class_qualified_name)
+        super_definition = find_definition_by_qualified_name(super_class_qualified_name)
+        break unless super_definition
+
+        result << super_definition
+        definition = super_definition
+      end
+      result
+    end
   end
 end

data/lib/rucoa/definitions/method_definition.rb

@@ -30,6 +30,17 @@ module Rucoa
         @types = types
       end
 
+      # @return [Boolean]
+      def instance_method?
+        @kind == :instance
+      end
+
+      # @todo
+      # @return [Array<Rucoa::Definitions::MethodParameter>]
+      def parameters
+        []
+      end
+
       # @return [String]
       # @example returns qualified name of method
       #   definition = Rucoa::Source.new(
@@ -52,12 +63,6 @@ module Rucoa
         ].join
       end
 
-      # @todo
-      # @return [Array<Rucoa::Definitions::MethodParameter>]
-      def parameters
-        []
-      end
-
       # @return [Array<String>]
       # @example returns return types
       #   definition = Rucoa::Source.new(
@@ -105,11 +110,6 @@ module Rucoa
         end
       end
 
-      # @return [Boolean]
-      def instance_method?
-        @kind == :instance
-      end
-
       # @return [Boolean]
       def singleton_method?
         !instance_method?

data/lib/rucoa/handler_concerns/configuration_requestable.rb

@@ -7,6 +7,13 @@ module Rucoa
 
       private
 
+      # @return [void]
+      def publish_diagnostics_on_each_source
+        source_store.each_uri do |uri|
+          publish_diagnostics_on(uri)
+        end
+      end
+
       # @return [void]
       def request_workspace_configuration
         write(
@@ -23,13 +30,6 @@ module Rucoa
           publish_diagnostics_on_each_source
         end
       end
-
-      # @return [void]
-      def publish_diagnostics_on_each_source
-        source_store.each_uri do |uri|
-          publish_diagnostics_on(uri)
-        end
-      end
     end
   end
 end

data/lib/rucoa/handler_concerns/diagnostics_publishable.rb

@@ -5,17 +5,6 @@ module Rucoa
     module DiagnosticsPublishable
       private
 
-      # @param uri [String]
-      # @return [Array<Hash>]
-      def diagnostics_on(uri)
-        return [] unless configuration.enables_diagnostics?
-
-        DiagnosticProvider.call(
-          source: source_store.get(uri),
-          uri: uri
-        )
-      end
-
       # @param uri [String]
       # @return [void]
       def clear_diagnostics_on(uri)
@@ -28,6 +17,17 @@ module Rucoa
         )
       end
 
+      # @param uri [String]
+      # @return [Array<Hash>]
+      def diagnostics_on(uri)
+        return [] unless configuration.enables_diagnostics?
+
+        DiagnosticProvider.call(
+          source: source_store.get(uri),
+          uri: uri
+        )
+      end
+
       # @param uri [String]
       # @return [void]
       def publish_diagnostics_on(uri)

data/lib/rucoa/handler_concerns/text_document_position_parameters.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module HandlerConcerns
+    module TextDocumentPositionParameters
+      private
+
+      # @return [Rucoa::Nodes::Base, nil]
+      def node
+        return unless position
+        return unless source
+
+        @node ||= source.node_at(position)
+      end
+
+      # @return [String, nil]
+      def parameter_position
+        @parameter_position ||= request.dig('params', 'position')
+      end
+
+      # @return [Rucoa::Position, nil]
+      def position
+        return unless parameter_position
+
+        @position ||= Position.from_vscode_position(parameter_position)
+      end
+    end
+  end
+end

data/lib/rucoa/handler_concerns/text_document_uri_parameters.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module HandlerConcerns
+    module TextDocumentUriParameters
+      private
+
+      # @return [String, nil]
+      def parameter_uri
+        @parameter_uri ||= request.dig('params', 'textDocument', 'uri')
+      end
+
+      # @return [Rucoa::Source, nil]
+      def source
+        return unless parameter_uri
+
+        @source ||= source_store.get(parameter_uri)
+      end
+    end
+  end
+end

data/lib/rucoa/handler_concerns.rb

@@ -4,5 +4,7 @@ module Rucoa
   module HandlerConcerns
     autoload :ConfigurationRequestable, 'rucoa/handler_concerns/configuration_requestable'
     autoload :DiagnosticsPublishable, 'rucoa/handler_concerns/diagnostics_publishable'
+    autoload :TextDocumentPositionParameters, 'rucoa/handler_concerns/text_document_position_parameters'
+    autoload :TextDocumentUriParameters, 'rucoa/handler_concerns/text_document_uri_parameters'
   end
 end

data/lib/rucoa/handlers/base.rb

@@ -41,15 +41,6 @@ module Rucoa
       # @return [Rucoa::Server]
       attr_reader :server
 
-      # @param message [Hash]
-      # @return [void]
-      def respond(message)
-        write(
-          id: request['id'],
-          result: message
-        )
-      end
-
       # @return [Rucoa::Configuration]
       def configuration
         @server.configuration
@@ -60,6 +51,15 @@ module Rucoa
         @server.definition_store
       end
 
+      # @param message [Hash]
+      # @return [void]
+      def respond(message)
+        write(
+          id: request['id'],
+          result: message
+        )
+      end
+
       # @return [Rucoa::SourceStore]
       def source_store
         @server.source_store

data/lib/rucoa/handlers/initialize_handler.rb

@@ -15,6 +15,7 @@ module Rucoa
             },
             definitionProvider: true,
             documentFormattingProvider: true,
+            documentHighlightProvider: true,
             documentRangeFormattingProvider: true,
             documentSymbolProvider: true,
             hoverProvider: true,