rubocop-on-rbs 1.9.1 → 2.0.0.dev

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6224717a0141088a343751d890d179a4233e4bb95c5eada1fead224c8fb1db6
-  data.tar.gz: 6c2f9e7c257973497c98b3d4c53b2592629da6e88f7de6c0111e575005700a9c
+  metadata.gz: cb12bf04d27c5b1e90a4537e696d0f43e3440653244e71ab14bd189ef876ad1d
+  data.tar.gz: 265c57dc1917d19594e7175696147db9668a48b57c1b463472488e8bae4eade6
 SHA512:
-  metadata.gz: 0f136c3bf5d2ef637de11ce42595f6e97689b1dc3468d60be0fffba48fa226fadb8b347234d9688be97ea0afba9137913d8552492150f7f8f038ddd2cc683fec
-  data.tar.gz: 8282fd38865f145c9a5b92e9cdeb9ed556147b3882847c259016ef9e59e1bf6580a5285cc7874c0edd89cd07fe78186407e201657483873357bfd808110597bd
+  metadata.gz: 808e37b431fcbad539a5fc99910816f15d00ccde4f35c9e3139e76c22b458680ab9a3e5130436d7fe4d83d9967cea0c777f07b542b72cc669b6011a9a20e29a6
+  data.tar.gz: 9951c42a0f33cdca49d1c580ceecbb0d774b3534794e55ed08e69e274a657f8262f218ed759de4ef93c99ffd1aba79da238225f32f96edc2a4e990e5caaa5a46

data/config/default.yml

@@ -27,10 +27,6 @@ RBS:
 RBS/Layout:
   Enabled: true
 
-RBS/Layout/AnnotationIndentation:
-  Description: 'Use 2 spaces for annotation indentation'
-  Enabled: true
-
 RBS/Layout/CommentIndentation:
   Description: 'Use 2 spaces for comment indentation'
   Enabled: true

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

@@ -21,47 +21,45 @@ module RuboCop
           MSG = "Incorrect indentation detected (column %<expect>s instead of %<actual>s)."
 
           def on_rbs_new_investigation
-            comments = processed_rbs_source.tokens.select { |token| token.type == :tLINECOMMENT }
-            comments.each_with_index do |token, comment_index|
-              check(token, comment_index)
+            indent_start_lines = Set.new
+            indent_end_lines = Set.new
+            processed_rbs_source.decls.each do |decl|
+              walk_decl(decl) do |d|
+                indent_start_lines << d.location.start_line
+                indent_end_lines << d.location.end_line
+              end
             end
-          end
 
-          def check(comment_token, _comment_index)
-            next_line = line_after_comment(comment_token)
-            correct_comment_indentation = correct_indentation(next_line)
-            column = comment_token.location.start_column
+            expected_width = 0
+            processed_rbs_source.tokens.each do |token|
+              case token.type
+              when :kMODULE, :kCLASS, :kINTERFACE
+                next unless indent_start_lines.include?(token.location.start_line)
 
-            column_delta = correct_comment_indentation - column
-            return if column_delta.zero?
+                expected_width += 2
+              when :kEND
+                next unless indent_end_lines.include?(token.location.start_line)
 
-            token_range = location_to_range(comment_token.location)
-            message = format(MSG, expect: correct_comment_indentation, actual: column)
-            add_offense(token_range, message: message) do |corrector|
-              line_start_pos = processed_source.buffer.line_range(comment_token.location.start_line).begin_pos
-              indent = range_between(line_start_pos, comment_token.location.start_pos)
-              corrector.replace(indent, ' ' * correct_comment_indentation)
+                expected_width -= 2
+              when :tLINECOMMENT
+                if token.location.start_column != expected_width
+                  token_range = location_to_range(token.location)
+                  message = format(MSG, expect: expected_width, actual: token.location.start_column)
+                  add_offense(token_range, message: message) do |corrector|
+                    line_start_pos = processed_source.buffer.line_range(token.location.start_line).begin_pos
+                    indent = range_between(line_start_pos, token.location.start_pos)
+                    corrector.replace(indent, ' ' * expected_width)
+                  end
+                end
+              end
             end
           end
 
-          def line_after_comment(comment)
-            lines = processed_source.lines
-            lines[comment.location.start_line..].find { |line| !line.blank? }
-          end
-
-          def correct_indentation(next_line)
-            return 0 unless next_line
-
-            indentation_of_next_line = next_line =~ /\S/
-            indentation_of_next_line + if less_indented?(next_line)
-                                         2
-                                       else
-                                         0
-                                       end
-          end
-
-          def less_indented?(line)
-            /\A\s*end\b/.match?(line)
+          def walk_decl(decl, &block)
+            if decl.respond_to?(:members)
+              yield decl
+              decl.members.each { |member| walk_decl(member, &block) }
+            end
           end
         end
       end

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

@@ -68,7 +68,7 @@ module RuboCop
           end
 
           def previous_line_ignoring_comments(processed_source, send_line)
-            processed_source[0..(send_line - 2)].reverse.find { |line| !comment_line?(line) }
+            processed_source[0..send_line - 2].reverse.find { |line| !comment_line?(line) }
           end
 
           def previous_line_empty?(send_line)

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

@@ -21,35 +21,19 @@ module RuboCop
 
           MSG = 'Empty line detected around overloads.'
 
-          # @rbs decl: ::RBS::AST::Members::MethodDefinition
-          # @rbs return: void
           def on_rbs_def(decl)
-            decl.overloads.each_cons(2) do |overload, next_overload|
-              end_line = overload&.method_type&.location&.end_line || 0
-              next_start_line = next_overload&.method_type&.location&.start_line || 0
-              check_empty_lines(end_line, next_start_line)
-            end
+            return unless 1 < decl.overloads.length
 
-            if decl.overloading? && decl.overloads.length.positive?
-              # : () -> void
-              #
-              #   | ...
-              end_location = decl.overloads.last.method_type.location or return
-              slice = processed_source.raw_source[end_location.end_pos..] or return
-              bar_index = slice.index('|') or return
-              bar_line = slice[0..bar_index]&.count("\n") or return
-              check_empty_lines(end_location.end_line, end_location.end_line + bar_line)
+            decl.overloads.each_cons(2) do |overload, next_overload|
+              check_empty_lines(overload, next_overload)
             end
           end
 
-          # @rbs end_line: Integer
-          # @rbs next_start_line: Integer
-          # @rbs return: void
-          def check_empty_lines(end_line, next_start_line)
-            return if end_line + 1 == next_start_line
+          def check_empty_lines(overload, next_overload)
+            return if overload.method_type.location.end_line + 1 == next_overload.method_type.location.start_line
 
             total = 0
-            range = end_line...(next_start_line - 1)
+            range = overload.method_type.location.end_line...(next_overload.method_type.location.start_line - 1)
             processed_source.raw_source.each_line.each_with_index do |line, lineno|
               if range.cover?(lineno) && line == "\n"
                 empty_line = range_between(total, total + 1)

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

@@ -39,11 +39,8 @@ module RuboCop
 
               loc = bar&.location
               next unless loc
+              next unless overload_starts.include?(base_pos + after.location.start_pos)
 
-              # pDOT3 is not included in decl.overloads
-              next unless overload_starts.include?(base_pos + after.location.start_pos) || after.type == :pDOT3
-
-              # () -> void | (Integer) -> void
               if before.location.end_line == bar.location.start_line
                 range = range_between(base_pos + bar.location.start_pos, base_pos + bar.location.end_pos)
                 add_offense(range, message: "Insert newline before `|`") do |corrector|
@@ -52,17 +49,12 @@ module RuboCop
                 end
               end
 
-              # () -> void
-              # |
-              # (Integer) -> void
               if bar.location.end_line != after.location.start_line
                 range = range_between(base_pos + bar.location.start_pos, base_pos + bar.location.end_pos)
                 add_offense(range, message: "Remove newline after `|`") do |corrector|
                   space = range_between(base_pos + bar.location.end_pos, base_pos + after.location.start_pos)
                   corrector.replace(space, ' ')
                 end
-              # : () -> void
-              #   | (Integer) -> void
               elsif bar.location.start_column != first_colon_column
                 range = range_between(base_pos + bar.location.start_pos, base_pos + bar.location.end_pos)
                 add_offense(range, message: 'Indent the `|` to the first `:`') do |corrector|

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

@@ -14,15 +14,8 @@ module RuboCop
         class SpaceAroundOperators < RuboCop::RBS::CopBase
           extend AutoCorrector
 
-          def on_rbs_class(decl)
-            check_type_params(decl)
-          end
-          alias on_rbs_module on_rbs_class
-          alias on_rbs_interface on_rbs_class
-
           def on_rbs_def(decl)
             decl.overloads.each do |overload|
-              check_type_params(overload.method_type)
               overload.method_type.each_type do |type|
                 check_type(type)
               end
@@ -33,14 +26,10 @@ module RuboCop
             check_type(decl.type)
           end
           alias on_rbs_global on_rbs_constant
+          alias on_rbs_type_alias on_rbs_constant
           alias on_rbs_attribute on_rbs_constant
           alias on_rbs_var on_rbs_constant
 
-          def on_rbs_type_alias(decl)
-            check_type_params(decl)
-            check_type(decl.type)
-          end
-
           def check_type(type)
             case type
             when ::RBS::Types::Union
@@ -53,13 +42,6 @@ module RuboCop
             end
           end
 
-          def check_type_params(decl)
-            decl.type_params.each do |type_param|
-              check_type(type_param.default_type) if type_param.default_type
-              check_type(type_param.upper_bound_type) if type_param.upper_bound_type
-            end
-          end
-
           def check_operator(type, operator)
             type.types.each_cons(2) do |before, after|
               next unless before.location.end_line == after.location.start_line

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

@@ -17,39 +17,25 @@ module RuboCop
 
           MSG = 'Use one space before overload.'
 
-          # @rbs decl: ::RBS::AST::Members::MethodDefinition
+          # @sig 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 or next
+              loc = overload.method_type.location
               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)
-            return unless char_start_pos
+              char_start_pos = source.rindex(overload_char, loc.start_pos)
+              next unless char_start_pos
 
-            word_after_char_pos = source.index(/[^\s]/, char_start_pos + 1)
-            return unless word_after_char_pos
+              word_after_char_pos = source.index(/[^\s]/, char_start_pos + 1)
+              next 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, ' ')
+              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
           end

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

@@ -13,7 +13,6 @@ 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

@@ -16,7 +16,6 @@ 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/initialize_return_type.rb

@@ -22,7 +22,6 @@ 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

@@ -16,7 +16,6 @@ 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/redundant_parentheses.rb

@@ -49,7 +49,6 @@ module RuboCop
           class ParenChecker
             include BeforeTokenIfLparen
             include RangeHelp
-
             attr_reader :processed_source
 
             def initialize(processed_source:, base:, tokens:, type:, skip:, cop:)

data/lib/rubocop/cop/rbs_cops.rb

@@ -2,7 +2,6 @@
 
 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'

data/lib/rubocop/rbs/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-on-rbs
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 2.0.0.dev
 platform: ruby
 authors:
 - ksss
@@ -27,16 +27,16 @@ dependencies:
   name: rbs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 4.0.0.dev.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 4.0.0.dev.4
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +84,6 @@ 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
@@ -160,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.6.9
 specification_version: 4
 summary: RuboCop extension for RBS file.
 test_files: []

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

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RBS
-      module Layout
-        # Checks the indentation of annotations in RBS.
-        #
-        # @example
-        #   # bad
-        #   # comment
-        #     %a{pure}
-        #   def foo: () -> void
-        #
-        #   # good
-        #   # comment
-        #   %a{pure}
-        #   def foo: () -> void
-        #
-        class AnnotationIndentation < RuboCop::RBS::CopBase
-          extend AutoCorrector
-
-          MSG = "Incorrect indentation detected (column %<expect>s instead of %<actual>s)."
-
-          def on_rbs_new_investigation
-            indent_start_lines = Set.new
-            indent_end_lines = Set.new
-            ignore_poses = Set.new
-            processed_rbs_source.decls.each do |decl|
-              walk_decl(decl) do |d|
-                indent_start_lines << d.location.start_line
-                indent_end_lines << d.location.end_line
-                d.members.each do |member|
-                  case member
-                  when ::RBS::AST::Members::MethodDefinition
-                    member.overloads.each do |overload|
-                      overload.annotations.each do |annotation|
-                        ignore_poses << annotation.location.start_pos
-                      end
-                    end
-                  end
-                end
-              end
-            end
-
-            expected_width = 0
-            last_annotation_line = -1
-            processed_rbs_source.tokens.each do |token|
-              case token.type
-              when :kMODULE, :kCLASS, :kINTERFACE
-                next unless indent_start_lines.include?(token.location.start_line)
-
-                expected_width += 2
-              when :kEND
-                next unless indent_end_lines.include?(token.location.start_line)
-
-                expected_width -= 2
-              when :tANNOTATION
-                next if ignore_poses.include?(token.location.start_pos)
-
-                if token.location.start_column == expected_width
-                  last_annotation_line = token.location.start_line
-                  next
-                end
-                next if last_annotation_line == token.location.start_line
-
-                token_range = location_to_range(token.location)
-                message = format(MSG, expect: expected_width, actual: token.location.start_column)
-                last_annotation_line = token.location.start_line
-                add_offense(token_range, message: message) do |corrector|
-                  line_start_pos = processed_source.buffer.line_range(token.location.start_line).begin_pos
-                  indent = range_between(line_start_pos, token.location.start_pos)
-                  corrector.replace(indent, ' ' * expected_width)
-                end
-              end
-            end
-          end
-
-          def walk_decl(decl, &block)
-            if decl.respond_to?(:members)
-              yield decl
-              decl.members.each { |member| walk_decl(member, &block) }
-            end
-          end
-        end
-      end
-    end
-  end
-end