rubocop-on-rbs 2.0.0.dev → 2.1.0

data/lib/rubocop/cop/rbs/layout/space_before_overload.rb

@@ -17,25 +17,39 @@ module RuboCop
 
           MSG = 'Use one space before overload.'
 
-          # @sig decl: ::RBS::AST::Members::MethodDefinition
+          # @rbs decl: ::RBS::AST::Members::MethodDefinition
           def on_rbs_def(decl)
-            source = processed_source.raw_source
             decl.overloads.each_with_index do |overload, i|
-              loc = overload.method_type.location
+              loc = overload.method_type.location or next
               overload_char = i == 0 ? ':' : '|'
+              check(loc, overload_char)
+            end
+
+            if decl.overloading?
+              loc = decl.location or return
+              overloading_loc = loc[:overloading] or return
+              overload_char = decl.overloads.length == 0 ? ':' : '|'
+              check(overloading_loc, overload_char)
+            end
+          end
+
+          private
+
+          # @rbs loc: ::RBS::Location[bot, bot]
+          def check(loc, overload_char)
+            source = processed_source.raw_source
 
-              char_start_pos = source.rindex(overload_char, loc.start_pos)
-              next unless char_start_pos
+            char_start_pos = source.rindex(overload_char, loc.start_pos)
+            return unless char_start_pos
 
-              word_after_char_pos = source.index(/[^\s]/, char_start_pos + 1)
-              next unless word_after_char_pos
+            word_after_char_pos = source.index(/[^\s]/, char_start_pos + 1)
+            return unless word_after_char_pos
 
-              if char_start_pos + 2 != word_after_char_pos
-                char = range_between(char_start_pos, char_start_pos + 1)
-                add_offense(char) do |corrector|
-                  range = range_between(char_start_pos + 1, word_after_char_pos)
-                  corrector.replace(range, ' ')
-                end
+            if char_start_pos + 2 != word_after_char_pos
+              char = range_between(char_start_pos, char_start_pos + 1)
+              add_offense(char) do |corrector|
+                range = range_between(char_start_pos + 1, word_after_char_pos)
+                corrector.replace(range, ' ')
               end
             end
           end

data/lib/rubocop/cop/rbs/lint/ambiguous_keyword_argument_key.rb

@@ -20,8 +20,9 @@ module RuboCop
               next unless func.kind_of?(::RBS::Types::Function)
               next unless !func.required_keywords.empty? || !func.optional_keywords.empty?
 
-              base_pos = overload.method_type.location.start_pos
-              lex_result = ::RBS::Parser.lex(overload.method_type.location.source)
+              location = overload.method_type.location or next
+              base_pos = location.start_pos
+              lex_result = ::RBS::Parser.lex(location.source)
               buf = []
               lex_result.value.each do |token|
                 case token.type

data/lib/rubocop/cop/rbs/lint/ambiguous_operator_precedence.rb

@@ -36,6 +36,8 @@ module RuboCop
 
           def check_type(type)
             on_type([::RBS::Types::Union], type) do |union|
+              next unless union.is_a?(::RBS::Types::Union)
+
               union.types.each do |t|
                 case t
                 when ::RBS::Types::Intersection

data/lib/rubocop/cop/rbs/lint/duplicate_annotation.rb

@@ -23,6 +23,7 @@ module RuboCop
         class DuplicateAnnotation < RuboCop::RBS::CopBase
           MSG = 'Duplicate annotation detected.'
 
+          #: (::RBS::AST::Members::MethodDefinition) -> void
           def on_rbs_def(decl)
             decl.annotations.each_with_index do |annotation, idx|
               next_annotations = decl.annotations[(idx + 1)..] or next
@@ -41,6 +42,7 @@ module RuboCop
             end
           end
 
+          #: (::RBS::AST::Annotation, Array[::RBS::AST::Annotation]) -> void
           def check_annotations(left_annotation, right_annotations)
             right_annotations.each do |right_annotation|
               next unless left_annotation == right_annotation

data/lib/rubocop/cop/rbs/lint/duplicate_overload.rb

@@ -20,13 +20,14 @@ module RuboCop
             overloads.each_with_index do |overload, idx|
               next if idx == overloads.size - 1
 
-              next_overloads = overloads[(idx + 1)..-1]
+              next_overloads = overloads[(idx + 1)..-1] or next
               next_overloads.each do |next_overload|
                 a = method_type_with_untyped_return_type(overload.method_type)
                 b = method_type_with_untyped_return_type(next_overload.method_type)
                 next unless a == b
 
-                range = location_to_range(next_overload.method_type.location)
+                location = next_overload.method_type.location or next
+                range = location_to_range(location)
                 add_offense(range)
               end
             end

data/lib/rubocop/cop/rbs/lint/new_returns_void.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-
 module RuboCop
   module Cop
     module RBS

data/lib/rubocop/cop/rbs/lint/top_level_interface.rb

@@ -27,17 +27,19 @@ module RuboCop
           end
 
           def on_rbs_class(decl)
-            return unless @last_end_pos.nil? || (@last_end_pos < decl.location.end_pos)
+            location = decl.location or return
+            return unless @last_end_pos.nil? || (@last_end_pos < location.end_pos)
 
-            @last_end_pos = decl.location.end_pos
+            @last_end_pos = location.end_pos
           end
           alias on_rbs_module on_rbs_class
 
           def on_rbs_interface(decl)
-            return unless @last_end_pos.nil? || (@last_end_pos < decl.location.start_pos)
+            location = decl.location or return
+            return unless @last_end_pos.nil? || (@last_end_pos < location.start_pos)
             return unless decl.name.namespace.path.empty?
 
-            range = location_to_range(decl.location)
+            range = location_to_range(location)
             add_offense(range)
           end
         end

data/lib/rubocop/cop/rbs/lint/top_level_type_alias.rb

@@ -23,18 +23,20 @@ module RuboCop
           end
 
           def on_rbs_class(decl)
-            return unless @last_end_pos.nil? || (@last_end_pos < decl.location.end_pos)
+            location = decl.location or return
+            return unless @last_end_pos.nil? || (@last_end_pos < location.end_pos)
 
-            @last_end_pos = decl.location.end_pos
+            @last_end_pos = location.end_pos
           end
           alias on_rbs_module on_rbs_class
           alias on_rbs_interface on_rbs_class
 
           def on_rbs_type_alias(decl)
-            return unless @last_end_pos.nil? || (@last_end_pos < decl.location.start_pos)
+            location = decl.location or return
+            return unless @last_end_pos.nil? || (@last_end_pos < location.start_pos)
             return unless decl.name.namespace.path.empty?
 
-            range = location_to_range(decl.location)
+            range = location_to_range(location)
             add_offense(range)
           end
         end

data/lib/rubocop/cop/rbs/lint/useless_access_modifier.rb

@@ -42,7 +42,7 @@ module RuboCop
           MSG = 'Useless `%<current>s` access modifier.'
 
           def on_rbs_class(decl)
-            current = nil
+            current = nil #: ::RBS::AST::Members::Public | ::RBS::AST::Members::Private | nil
             unused = true
             decl.members.each do |member|
               next unless member.location
@@ -71,8 +71,8 @@ module RuboCop
               end
             end
 
-            if unused && current
-              range = location_to_range(current.location)
+            if unused && current && (location = current.location)
+              range = location_to_range(location)
               vis = case current
                     when ::RBS::AST::Members::Public
                       'public'

data/lib/rubocop/cop/rbs/style/block_return_boolish.rb

@@ -13,6 +13,7 @@ module RuboCop
         #
         class BlockReturnBoolish < RuboCop::RBS::CopBase
           extend AutoCorrector
+
           MSG = 'Use `boolish` instead of `bool` in block return type.'
 
           # @sig decl: ::RBS::AST::Members::MethodDefinition

data/lib/rubocop/cop/rbs/style/class_with_singleton.rb

@@ -1,4 +1,3 @@
-# rbs_inline: enabled
 # frozen_string_literal: true
 
 module RuboCop
@@ -16,6 +15,7 @@ module RuboCop
         #
         class ClassWithSingleton < RuboCop::RBS::CopBase
           extend AutoCorrector
+
           MSG = 'Use `self` instead of `class`.'
 
           # @rbs decl: RBS::AST::Members::MethodDefinition

data/lib/rubocop/cop/rbs/style/classic_type.rb

@@ -20,7 +20,7 @@ module RuboCop
         class ClassicType < RuboCop::RBS::CopBase
           extend AutoCorrector
 
-          Types = ::RBS::Types
+          Types = ::RBS::Types #: module-alias
 
           def on_rbs_def(decl)
             decl.overloads.each do |overload|
@@ -38,7 +38,7 @@ module RuboCop
           alias on_rbs_attribute on_rbs_constant
           alias on_rbs_var on_rbs_constant
 
-          # @rbs type: ::RBS::Types::t
+          #: (::RBS::Types::t type) -> untyped
           def check_type(type)
             find_replacement(type) do |t, replaced|
               range = location_to_range(t.location)
@@ -48,6 +48,7 @@ module RuboCop
             end
           end
 
+          #: (::RBS::Types::t type) ?{ ([::RBS::Types::t, String]) -> untyped } -> untyped
           def find_replacement(type, &block)
             case type
             when Types::Record,
@@ -64,11 +65,11 @@ module RuboCop
             when Types::ClassInstance
               case type.name.to_s
               when 'TrueClass', '::TrueClass'
-                block.call([type, 'true'])
+                block&.call([type, 'true'])
               when 'FalseClass', '::FalseClass'
-                block.call([type, 'false'])
+                block&.call([type, 'false'])
               when 'NilClass', '::NilClass'
-                block.call([type, 'nil'])
+                block&.call([type, 'nil'])
               end
               type.each_type do |arg|
                 find_replacement(arg, &block)

data/lib/rubocop/cop/rbs/style/initialize_return_type.rb

@@ -22,6 +22,7 @@ module RuboCop
         #
         class InitializeReturnType < RuboCop::RBS::CopBase
           extend AutoCorrector
+
           MSG = '`#initialize` method should return `void`'
 
           def on_rbs_def(decl)

data/lib/rubocop/cop/rbs/style/instance_with_instance.rb

@@ -1,4 +1,3 @@
-# rbs_inline: enabled
 # frozen_string_literal: true
 
 module RuboCop
@@ -16,6 +15,7 @@ module RuboCop
         #
         class InstanceWithInstance < RuboCop::RBS::CopBase
           extend AutoCorrector
+
           MSG = 'Use `self` instead of `instance`.'
 
           # @rbs decl: RBS::AST::Declarations::Class

data/lib/rubocop/cop/rbs/style/optional_nil.rb

@@ -46,7 +46,7 @@ module RuboCop
             when ::RBS::Types::Optional
               case type.type
               when ::RBS::Types::Bases::Nil
-                block.call([type, ::RBS::Types::Bases::Nil.new(location: nil)])
+                block&.call([type, ::RBS::Types::Bases::Nil.new(location: nil)])
               else
                 find_replacement(type.type, &block)
               end

data/lib/rubocop/cop/rbs/style/redundant_parentheses.rb

@@ -49,8 +49,16 @@ module RuboCop
           class ParenChecker
             include BeforeTokenIfLparen
             include RangeHelp
+
             attr_reader :processed_source
 
+            # @rbs processed_source: RuboCop::AST::ProcessedSource
+            # @rbs base: Integer
+            # @rbs tokens: Array[::RBS::Parser::Token]
+            # @rbs type: ::RBS::Types::t
+            # @rbs skip: Set[Integer]
+            # @rbs cop: RuboCop::RBS::CopBase
+            # @rbs return: void
             def initialize(processed_source:, base:, tokens:, type:, skip:, cop:)
               @processed_source = processed_source
               @base = base
@@ -62,6 +70,8 @@ module RuboCop
 
             def check
               @cop.on_type([::RBS::Types::Proc], @type) do |proc_type|
+                next unless proc_type.is_a?(::RBS::Types::Proc)
+
                 before_token_if_lparen(@tokens, @base, proc_type.type) do |b|
                   @skip << (b.location.start_pos + @base)
                 end
@@ -85,7 +95,9 @@ module RuboCop
                     case type.type.literal
                     when Symbol
                       # Skip optional with symbol literal (e.g. `(:sym)?`)
-                      @skip << type.location.start_pos
+                      if (location = type.location)
+                        @skip << location.start_pos
+                      end
                     end
                   end
                 end
@@ -121,8 +133,9 @@ module RuboCop
           extend AutoCorrector
 
           def on_rbs_def(decl)
-            base = decl.location.start_pos
-            tokens = tokenize(decl.location.source)
+            location = decl.location or return
+            base = location.start_pos
+            tokens = tokenize(location.source)
             skip = Set.new
             decl.overloads.each do |overload|
               before_token_if_lparen(tokens, base, overload.method_type.type) do |b|
@@ -151,9 +164,10 @@ module RuboCop
           end
 
           def on_rbs_constant(const)
-            tokens = tokenize(const.location.source)
+            location = const.location or return
+            tokens = tokenize(location.source)
             type = const.type
-            base = const.location.start_pos
+            base = location.start_pos
             check_type(tokens:, type:, base:)
           end
           alias on_rbs_global on_rbs_constant

data/lib/rubocop/cop/rbs/style/true_false.rb

@@ -82,7 +82,7 @@ module RuboCop
                   end
                 end
                 replaced.insert(first_index || 0, ::RBS::Types::Bases::Bool.new(location: nil))
-                block.call([type, ::RBS::Types::Union.new(types: replaced, location: nil)])
+                block&.call([type, ::RBS::Types::Union.new(types: replaced, location: nil)])
               end
             else
               type.each_type do |type|

data/lib/rubocop/cop/rbs_cops.rb

@@ -2,6 +2,7 @@
 
 require 'rbs'
 
+require_relative 'rbs/layout/annotation_indentation'
 require_relative 'rbs/layout/comment_indentation'
 require_relative 'rbs/layout/empty_line_between_declarations'
 require_relative 'rbs/layout/empty_lines_around_access_modifier'
@@ -37,7 +38,6 @@ require_relative 'rbs/lint/top_level_type_alias'
 require_relative 'rbs/lint/unused_overload_type_params'
 require_relative 'rbs/lint/unused_type_alias_type_params'
 require_relative 'rbs/lint/useless_access_modifier'
-require_relative 'rbs/lint/will_syntax_error'
 
 require_relative 'rbs/style/block_return_boolish'
 require_relative 'rbs/style/class_with_singleton'

data/lib/rubocop/rbs/cop_base.rb

@@ -9,7 +9,7 @@ module RuboCop
       include RuboCop::Cop::RangeHelp
       include RuboCop::RBS::OnTypeHelper
 
-      attr_reader :processed_rbs_source
+      attr_reader :processed_rbs_source #: RuboCop::RBS::ProcessedRBSSource
 
       exclude_from_registry
 
@@ -34,6 +34,7 @@ module RuboCop
         @processed_rbs_source = RuboCop::RBS::ProcessedRBSSource.new(buffer)
       end
 
+      #: () -> void
       def investigation_rbs
         return unless processed_source.buffer.name.then { |n| n.end_with?(".rbs") || n == "(string)" }
 
@@ -65,22 +66,47 @@ module RuboCop
         end
       end
 
+      #: () -> void
       def on_rbs_new_investigation; end
+
+      #: () -> void
       def on_rbs_parsing_error; end
 
       # other on_* methods should sync with `#walk` method
+      #: (::RBS::AST::Declarations::Class) -> void
       def on_rbs_class(member); end
+
+      #: (::RBS::AST::Declarations::Module) -> void
       def on_rbs_module(member); end
+
+      #: (::RBS::AST::Declarations::Interface) -> void
       def on_rbs_interface(member); end
+
+      #: (::RBS::AST::Declarations::Constant) -> void
       def on_rbs_constant(const); end
+
+      #: (::RBS::AST::Declarations::Global) -> void
       def on_rbs_global(global); end
+
+      #: (::RBS::AST::Declarations::TypeAlias) -> void
       def on_rbs_type_alias(decl); end
+
+      #: (::RBS::AST::Members::MethodDefinition) -> void
       def on_rbs_def(member); end
+
+      #: (::RBS::AST::Members::Attribute) -> void
       def on_rbs_attribute(member); end
+
+      #: (::RBS::AST::Members::Public) -> void
       def on_rbs_public(member); end
+
+      #: (::RBS::AST::Members::Private) -> void
       def on_rbs_private(member); end
+
+      #: (::RBS::AST::Members::Var) -> void
       def on_rbs_var(member); end
 
+      #: (untyped) -> void
       def walk(decl)
         case decl
         when ::RBS::AST::Declarations::Module
@@ -111,6 +137,7 @@ module RuboCop
         end
       end
 
+      #: () -> ::RBS::Buffer
       def rbs_buffer
         ::RBS::Buffer.new(
           name: processed_source.buffer.name,
@@ -118,6 +145,7 @@ module RuboCop
         )
       end
 
+      #: (::RBS::Location[untyped, untyped]) -> Parser::Source::Range
       def location_to_range(location)
         range_between(location.start_pos, location.end_pos)
       end

data/lib/rubocop/rbs/on_type_helper.rb

@@ -3,6 +3,7 @@
 module RuboCop
   module RBS
     module OnTypeHelper
+      #: (Array[Class] types, ::RBS::Types::t type) { (::RBS::Types::t t) -> void } -> void
       def on_type(types, type, &block)
         case type
         when *types
@@ -13,6 +14,7 @@ module RuboCop
         end
       end
 
+      #: (Array[Class] types, ::RBS::Types::t type) { (::RBS::Types::t t) -> void } -> void
       def on_not_type(types, type, &block)
         case type
         when *types

data/lib/rubocop/rbs/processed_rbs_source.rb

@@ -2,14 +2,18 @@
 
 module RuboCop
   module RBS
+    # Fake for RuboCop::ProcessedSource
     class ProcessedRBSSource
-      attr_reader :raw_source
+      # @rbs @tokens: ::Array[::RBS::Parser::Token]?
+
+      attr_reader :raw_source #: String
       attr_reader :source
-      attr_reader :buffer
-      attr_reader :directives
-      attr_reader :decls
-      attr_reader :error
+      attr_reader :buffer #: ::RBS::Buffer
+      attr_reader :directives #: ::Array[::RBS::AST::Directives::t]
+      attr_reader :decls #: ::Array[::RBS::AST::Declarations::t]
+      attr_reader :error #: ::RBS::ParsingError?
 
+      #: (::RBS::Buffer source) -> void
       def initialize(source)
         @raw_source = source.content
         @buffer, @directives, @decls = ::RBS::Parser.parse_signature(source)
@@ -23,6 +27,7 @@ module RuboCop
         @error.nil?
       end
 
+      #: () -> ::Array[::RBS::Parser::Token]
       def tokens
         @tokens ||= ::RBS::Parser.lex(buffer).value
       end

data/lib/rubocop/rbs/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module RBS
-    VERSION = '2.0.0.dev'
+    VERSION = '2.1.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-on-rbs
 version: !ruby/object:Gem::Version
-  version: 2.0.0.dev
+  version: 2.1.0
 platform: ruby
 authors:
 - ksss
@@ -27,16 +27,16 @@ dependencies:
   name: rbs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.dev.4
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.dev.4
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ files:
 - README.md
 - config/default.yml
 - lib/rubocop-on-rbs.rb
+- lib/rubocop/cop/rbs/layout/annotation_indentation.rb
 - lib/rubocop/cop/rbs/layout/comment_indentation.rb
 - lib/rubocop/cop/rbs/layout/empty_line_between_declarations.rb
 - lib/rubocop/cop/rbs/layout/empty_lines.rb
@@ -118,7 +119,6 @@ files:
 - lib/rubocop/cop/rbs/lint/unused_overload_type_params.rb
 - lib/rubocop/cop/rbs/lint/unused_type_alias_type_params.rb
 - lib/rubocop/cop/rbs/lint/useless_access_modifier.rb
-- lib/rubocop/cop/rbs/lint/will_syntax_error.rb
 - lib/rubocop/cop/rbs/style/block_return_boolish.rb
 - lib/rubocop/cop/rbs/style/class_with_singleton.rb
 - lib/rubocop/cop/rbs/style/classic_type.rb
@@ -152,14 +152,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: RuboCop extension for RBS file.
 test_files: []