rubocop-on-rbs 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5b6281c999414ec9c0c147ae2f49e1eb89374b7b159319ae867248305e87be
-  data.tar.gz: dfe65d9221973785fdf15d78fd011e3f3b27410ae329f6830f3f9074f04dc2fe
+  metadata.gz: 501f65e78ff030f4d111a08793afa70a614c28715e9d9fa4caa95e24bbcc48dd
+  data.tar.gz: 5600ce340c99239465721d201d75881e3bcd8343787659bbf18faaaf8f51f58f
 SHA512:
-  metadata.gz: 2e3828108b1e14abbbc491f19bb4b9d96211e46449e536ecd64a4b1d2310933e91f5b12ee8ad06b6ffd1dbf45134c2f87d1836868d9a5885072a47fa16018042
-  data.tar.gz: 174bf5a55e04b90c63c0e5d2c3b7164c4be900dd547214e12e67e376077f7c06b6e7c41ee206bfa4f77fe1af59119663f5a85732b6f38241b58467d79252303f
+  metadata.gz: 9506a4022805eeaabedd6de962bc91812f34176e40251cb902b4abaee2a5b7fc45dd962946032dcf5cedea397f88daec6d46cae9e54ccc8d9c3f35a6b9941b15
+  data.tar.gz: 3b0176a6d2aa9fc2a85c21445720b9571e8881d6cd742c9b1b534ca76ff5103bc340e38a417e0bf6aec32259b5818aa24872553bdff3e6e47096eba19291cc9f

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 ## [Unreleased]
 
+## [1.1.0] - 2024-10-01
+
+* Add RBS/Layout/EmptyLinesAroundAccessModifier by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/39
+* Fix error when same line with `RBS/Layout/EndAlignment` by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/40
+
+## [1.0.0] - 2024-09-17
+
+* Add RBS/Layout/EmptyLines by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/35
+* Fix doc for EmptyLinesAroundOverloads by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/36
+* Add Layout/EmptyLinesAround{Class,Module}Body by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/37
+* Add RBS/Layout/EmptyLinesAroundInterfaceBody by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/38
+
+## [0.9.0] - 2024-08-07
+
+* Fix error if includes multibyte characters by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/31
+
+## [0.8.0] - 2024-08-06
+
+* Fix use of argument in upper_bound by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/24
+* Security update by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/29
+
 ## [0.7.0] - 2024-06-27
 
 * Add RBS/Lint/AmbiguousOperatorPrecedence by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/22

data/config/default.yml

@@ -31,6 +31,10 @@ RBS/Layout/CommentIndentation:
   Description: 'Use 2 spaces for comment indentation'
   Enabled: true
 
+RBS/Layout/EmptyLinesAroundAccessModifier:
+  Description: "Keeps track of empty lines around access modifiers."
+  Enabled: true
+
 RBS/Layout/EmptyLinesAroundClassBody:
   Description: "Keeps track of empty lines around class bodies."
   Enabled: true
@@ -114,6 +118,16 @@ RBS/Lint/Syntax:
   Description: 'Check RBS syntax'
   Enabled: true
 
+RBS/Lint/TopLevelInterface:
+  Description: 'Check top level interface'
+  Enabled: pending
+  VersionAdded: '1.2.0'
+
+RBS/Lint/TopLevelTypeAlias:
+  Description: 'Check top level type alias'
+  Enabled: pending
+  VersionAdded: '1.2.0'
+
 RBS/Lint/UselessAccessModifier:
   AutoCorrect: contextual
   Description: 'Check useless access modifier'

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        # Access modifiers should be surrounded by blank lines.
+        #
+        #   # bad
+        #   class Foo
+        #     def bar: () -> void
+        #     private
+        #     def baz: () -> void
+        #   end
+        #
+        #   # good
+        #   class Foo
+        #     def bar: () -> void
+        #
+        #     private
+        #
+        #     def baz: () -> void
+        #   end
+        #
+        class EmptyLinesAroundAccessModifier < RuboCop::RBS::CopBase
+          extend AutoCorrector
+
+          MSG = 'Keep a blank line before and after `<%<kind>s>`.'
+
+          def on_rbs_class(decl)
+            @class_or_module_def_first_line = decl.location.start_line
+            @class_or_module_def_last_line = decl.location.end_line
+          end
+          alias on_rbs_module on_rbs_class
+
+          def on_rbs_public(member)
+            check(member, 'public')
+          end
+
+          def on_rbs_private(member)
+            check(member, 'private')
+          end
+
+          def check(member, kind)
+            line = member.location.start_line
+
+            before = processed_source.lines[line - 2]
+            if before.empty? || before.match?(/[^\s]/)
+              add_offense_with(member, kind)
+            end
+
+            after = processed_source.lines[line]
+            if after&.empty? || after&.match?(/[^\s]/)
+              add_offense_with(member, kind)
+            end
+          end
+
+          def add_offense_with(member, kind)
+            return if expected_empty_lines?(member)
+
+            range = location_to_range(member.location)
+            add_offense(range, message: format(MSG, kind: kind)) do |corrector|
+              current_line = range_by_whole_lines(range)
+              corrector.insert_before(current_line, "\n") unless previous_line_empty?(member.location.start_line)
+              corrector.insert_after(current_line, "\n") unless next_line_empty?(member.location.end_line)
+            end
+          end
+
+          def previous_line_ignoring_comments(processed_source, send_line)
+            processed_source[0..send_line - 2].reverse.find { |line| !comment_line?(line) }
+          end
+
+          def previous_line_empty?(send_line)
+            previous_line = previous_line_ignoring_comments(processed_source, send_line)
+            return true unless previous_line
+
+            class_def?(send_line) || previous_line.blank?
+          end
+
+          def next_line_empty?(last_send_line)
+            next_line = processed_source[last_send_line]
+
+            body_end?(last_send_line) || next_line.blank?
+          end
+
+          def expected_empty_lines?(member)
+            previous_line_empty?(member.location.start_line) && next_line_empty?(member.location.end_line)
+          end
+
+          def class_def?(line)
+            return false unless @class_or_module_def_first_line
+
+            line == @class_or_module_def_first_line + 1
+          end
+
+          def body_end?(line)
+            return false unless @class_or_module_def_last_line
+
+            line == @class_or_module_def_last_line - 1
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,6 +12,7 @@ module RuboCop
           def check(decl)
             first_line = decl.location.start_line
             last_line = decl.location.end_line
+            return if last_line == first_line
 
             check_beginning(first_line)
             check_ending(last_line)
@@ -29,7 +30,6 @@ module RuboCop
             return unless line_no.positive?
             return unless processed_source.lines[line_no]
             return unless processed_source.lines[line_no].empty?
-            return unless processed_source.lines[line_no + 1]
 
             range = source_range(processed_source.buffer, line_no + 1, 0)
             message = message(MSG_EXTRA, desc)

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

@@ -34,6 +34,8 @@ module RuboCop
           end
 
           def check(decl, expect:)
+            return if decl.location.start_line == decl.location.end_line
+
             end_loc = decl.location[:end]
             actual = end_loc.start_column
             if actual != expect

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module RBS
       module Lint
-        # Checks that there are no repeated overload bodies
+        # Checks for ambiguity of Union and Intersection operators.
         #
         # @example default
         #   # bad

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Lint
+        # Top-level namespaces are likely to conflict and should be avoided.
+        #
+        # @example
+        #   # bad
+        #   interface _Option
+        #     def option: () -> untyped
+        #   end
+        #
+        #   # good
+        #   class Foo
+        #     interface _Option
+        #       def option: () -> untyped
+        #     end
+        #   end
+        #
+        class TopLevelInterface < RuboCop::RBS::CopBase
+          MSG = 'Top level interface detected.'
+
+          def on_rbs_new_investigation
+            @last_end = nil
+          end
+
+          def on_rbs_class(decl)
+            return unless @last_end_pos.nil? || (@last_end_pos < decl.location.end_pos)
+
+            @last_end_pos = decl.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)
+
+            range = location_to_range(decl.location)
+            add_offense(range)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Lint
+        # Top-level namespaces are likely to conflict and should be avoided.
+        #
+        # @example
+        #   # bad
+        #   type foo = String
+        #
+        #   # good
+        #   class Foo
+        #     type bar = Integer
+        #   end
+        #
+        class TopLevelTypeAlias < RuboCop::RBS::CopBase
+          MSG = 'Top level type alias detected.'
+
+          def on_rbs_new_investigation
+            @last_end = nil
+          end
+
+          def on_rbs_class(decl)
+            return unless @last_end_pos.nil? || (@last_end_pos < decl.location.end_pos)
+
+            @last_end_pos = decl.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)
+
+            range = location_to_range(decl.location)
+            add_offense(range)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rbs_cops.rb

@@ -3,6 +3,7 @@
 require 'rbs'
 
 require_relative 'rbs/layout/comment_indentation'
+require_relative 'rbs/layout/empty_lines_around_access_modifier'
 require_relative 'rbs/layout/empty_lines_around_body'
 require_relative 'rbs/layout/empty_lines_around_class_body'
 require_relative 'rbs/layout/empty_lines_around_interface_body'
@@ -24,6 +25,8 @@ require_relative 'rbs/lint/ambiguous_operator_precedence'
 require_relative 'rbs/lint/duplicate_overload'
 require_relative 'rbs/lint/literal_intersection'
 require_relative 'rbs/lint/syntax'
+require_relative 'rbs/lint/top_level_interface'
+require_relative 'rbs/lint/top_level_type_alias'
 require_relative 'rbs/lint/useless_access_modifier'
 require_relative 'rbs/lint/useless_overload_type_params'
 require_relative 'rbs/lint/will_syntax_error'

data/lib/rubocop/rbs/cop_base.rb

@@ -71,6 +71,8 @@ module RuboCop
       def on_rbs_type_alias(decl); end
       def on_rbs_def(member); end
       def on_rbs_attribute(member); end
+      def on_rbs_public(member); end
+      def on_rbs_private(member); end
 
       def walk(decl)
         case decl
@@ -93,6 +95,10 @@ module RuboCop
           on_rbs_def(decl)
         when ::RBS::AST::Members::Attribute
           on_rbs_attribute(decl)
+        when ::RBS::AST::Members::Public
+          on_rbs_public(decl)
+        when ::RBS::AST::Members::Private
+          on_rbs_private(decl)
         end
       end
 

data/lib/rubocop/rbs/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module RBS
-    VERSION = '1.0.0'
+    VERSION = '1.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-on-rbs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -67,6 +67,7 @@ files:
 - lib/rubocop-on-rbs.rb
 - lib/rubocop/cop/rbs/layout/comment_indentation.rb
 - lib/rubocop/cop/rbs/layout/empty_lines.rb
+- lib/rubocop/cop/rbs/layout/empty_lines_around_access_modifier.rb
 - lib/rubocop/cop/rbs/layout/empty_lines_around_body.rb
 - lib/rubocop/cop/rbs/layout/empty_lines_around_class_body.rb
 - lib/rubocop/cop/rbs/layout/empty_lines_around_interface_body.rb
@@ -86,6 +87,8 @@ files:
 - lib/rubocop/cop/rbs/lint/duplicate_overload.rb
 - lib/rubocop/cop/rbs/lint/literal_intersection.rb
 - lib/rubocop/cop/rbs/lint/syntax.rb
+- lib/rubocop/cop/rbs/lint/top_level_interface.rb
+- lib/rubocop/cop/rbs/lint/top_level_type_alias.rb
 - lib/rubocop/cop/rbs/lint/useless_access_modifier.rb
 - lib/rubocop/cop/rbs/lint/useless_overload_type_params.rb
 - lib/rubocop/cop/rbs/lint/will_syntax_error.rb
@@ -127,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: RuboCop extension for RBS file.