rucoa 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05869f9180ae7dbf00c359ad9d0b89fe3b126c8f9a6171b8b8155c7ad683f95f'
-  data.tar.gz: 429c84f3e305a90bcc1b7c39fbb14af894a95e24117c91d6914681ae8c53624c
+  metadata.gz: 4ffd244eb4ed0935120e2d33a03798897a4880e06ff999c1779a920e4926215c
+  data.tar.gz: fe7296dba2ff6d185a729e6649cd9630a5644961837d28306f3a5a193643d38e
 SHA512:
-  metadata.gz: db443ae921e01609343392377664bf625bb4c2a057dc9d41ec1d611a7723807e6499d6669f097fb7d903b706110b6a34d83c09539612aba9d7b0e2fbd2302cf0
-  data.tar.gz: a6dabfb0fb1ac3228cb7217c9f9360fe6f32de32b65642492f00dbdc628d4578ed1c3a4f799c94c42ca8fe2553b3426c2105582569f9acd3e9971d68cc6722ec
+  metadata.gz: 9f9965f568980d2f069a5670dcf5e008986399b8826a331410bdd0f31cacf10a01068bc8e37109241ccd2c1e79bf9f0bc639600b7608260fffd02b07251e310b
+  data.tar.gz: 1143b279fbbf845f07f0654b37eadf20226d96b1dc930ceea5fd9fc3daf90b6bd786d3a55c08b9601019d85b0e79284de1268de5ed628136cb0097be3e6af846

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    rucoa (0.5.0)
+    rucoa (0.5.1)
       parser
       rbs
       rubocop
+      yard
 
 GEM
   remote: https://rubygems.org/

data/lib/rucoa/configuration.rb

@@ -6,32 +6,32 @@ module Rucoa
       @settings = {}
     end
 
-    # @return [Boolean]
+    # @return [void]
     def disable_code_action
       disable('codeAction')
     end
 
-    # @return [Boolean]
+    # @return [void]
     def disable_diagnostics
       disable('diagnostics')
     end
 
-    # @return [Boolean]
+    # @return [void]
     def disable_document_symbol
       disable('documentSymbol')
     end
 
-    # @return [Boolean]
+    # @return [void]
     def disable_formatting
       disable('formatting')
     end
 
-    # @return [Boolean]
+    # @return [void]
     def disable_selection_range
       disable('selectionRange')
     end
 
-    # @return [Boolean]
+    # @return [void]
     def disable_signature_help
       disable('signatureHelp')
     end

data/lib/rucoa/definition_builders/yard_method_definition_builder.rb

@@ -131,10 +131,37 @@ module Rucoa
       end
 
       # @return [Array<String>]
+      # @return [String]
+      # @example returns return type annotated by YARD @return tags
+      #   definitions = Rucoa::YardStringDocumentLoader.call(
+      #     content: <<~RUBY,
+      #       # @return [String]
+      #       def foo
+      #         'foo'
+      #       end
+      #     RUBY
+      #     path: '/path/to/foo.rb'
+      #   )
+      #   expect(definitions.first.return_types).to eq(
+      #     %w[
+      #       String
+      #     ]
+      #   )
+      # @example ignores empty @return tags
+      #   definitions = Rucoa::YardStringDocumentLoader.call(
+      #     content: <<~RUBY,
+      #       # @return []
+      #       def foo
+      #         'foo'
+      #       end
+      #     RUBY
+      #     path: '/path/to/foo.rb'
+      #   )
+      #   expect(definitions.first.return_types).to eq([])
       def return_types
         return %w[Object] if return_tags.empty?
 
-        return_tags.flat_map(&:types).map do |type|
+        return_tags.flat_map(&:types).compact.map do |type|
           YardType.new(type).to_rucoa_type
         end
       end
@@ -173,7 +200,7 @@ module Rucoa
         #     'Hash{Symbol => Object}'
         #   )
         #   expect(yard_type.to_rucoa_type).to eq('Hash')
-        # @exampel scrubs "Array<Array<Integer>>" to "Array"
+        # @example scrubs "Array<Array<Integer>>" to "Array"
         #   yard_type = Rucoa::DefinitionBuilders::YardMethodDefinitionBuilder::YardType.new(
         #     'Array<Array<Integer>>'
         #   )

data/lib/rucoa/handlers/text_document_document_symbol_handler.rb

@@ -40,7 +40,7 @@ module Rucoa
       ]
 
       def call
-        return unless respondable?
+        return unless responsible?
 
         respond(document_symbols)
       end
@@ -206,8 +206,9 @@ module Rucoa
       end
 
       # @return [Boolean]
-      def respondable?
-        configuration.enables_document_symbol? && source
+      def responsible?
+        configuration.enables_document_symbol? &&
+          !source.nil?
       end
 
       # @return [Rucoa::Source]

data/lib/rucoa/handlers/text_document_selection_range_handler.rb

@@ -4,7 +4,7 @@ module Rucoa
   module Handlers
     class TextDocumentSelectionRangeHandler < Base
       def call
-        return unless respondable?
+        return unless responsible?
 
         respond(
           positions.filter_map do |position|
@@ -19,9 +19,9 @@ module Rucoa
       private
 
       # @return [Boolean]
-      def respondable?
+      def responsible?
         configuration.enables_selection_range? &&
-          source
+          !source.nil?
       end
 
       # @return [Rucoa::Source]

data/lib/rucoa/handlers/text_document_signature_help_handler.rb

@@ -11,7 +11,7 @@ module Rucoa
 
       # @return [Hash]
       def signature_help
-        return unless respondable?
+        return unless responsible?
 
         {
           signatures: signature_informations
@@ -19,7 +19,7 @@ module Rucoa
       end
 
       # @return [Boolean]
-      def respondable?
+      def responsible?
         configuration.enables_signature_help? &&
           node.is_a?(Nodes::SendNode)
       end

data/lib/rucoa/node_inspector.rb

@@ -11,16 +11,16 @@ module Rucoa
       @node = node
     end
 
-    # @return [Array<String>, nil]
+    # @return [Array<String>]
     def method_definitions
-      method_full_qualified_name&.flat_map do |full_qualified_name|
+      method_full_qualified_names.flat_map do |full_qualified_name|
         @definition_store.select_by_full_qualified_name(full_qualified_name)
       end
     end
 
-    # @return [Array<String>, nil]
+    # @return [Array<String>]
     def method_receiver_types
-      return unless @node.is_a?(Nodes::SendNode)
+      return [] unless @node.is_a?(Nodes::SendNode)
 
       if @node.receiver
         self.class.new(
@@ -32,7 +32,7 @@ module Rucoa
       end
     end
 
-    # @return [Array<String>, nil]
+    # @return [Array<String>]
     def return_types
       case @node.type
       when :const
@@ -67,14 +67,16 @@ module Rucoa
         %w[Regexp]
       when true
         %w[TrueClass]
+      else
+        []
       end
     end
 
     private
 
-    # @return [Array<String>, nil]
-    def method_full_qualified_name
-      method_receiver_types&.map do |type|
+    # @return [Array<String>]
+    def method_full_qualified_names
+      method_receiver_types.map do |type|
         [
           type,
           @node.name
@@ -101,7 +103,7 @@ module Rucoa
 
     # @return [Array<String>]
     def return_types_for_send
-      method_full_qualified_name.flat_map do |full_qualified_name|
+      method_full_qualified_names.flat_map do |full_qualified_name|
         @definition_store.select_by_full_qualified_name(full_qualified_name).flat_map(&:return_types)
       end.uniq
     end

data/lib/rucoa/position.rb

@@ -47,8 +47,8 @@ module Rucoa
     # @return [Hash]
     def to_vscode_position
       {
-        character: @column,
-        line: @line - 1
+        'character' => @column,
+        'line' => @line - 1
       }
     end
   end

data/lib/rucoa/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rucoa
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/rucoa.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'parser'
   spec.add_dependency 'rbs'
   spec.add_dependency 'rubocop'
+  spec.add_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rucoa
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-10 00:00:00.000000000 Z
+date: 2022-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - r7kamura@gmail.com