rubocop-on-rbs 0.9.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4d3028aa7f179da033cd2e9bebee2f82b22f38cfece0af39f4407964c0c5535
-  data.tar.gz: f04f255a1bffc5e7d73cc5e61145a3d06c94f6009778698404fa9de6d1cfc4e1
+  metadata.gz: 1c58e575d4d662fa8cf0539226bc2c9f2bcd9358cfd751c3e776ce6f66ebcb86
+  data.tar.gz: 7e7411ebc61e2dfc2751fb3cb3e827580ecc5c7715c0eb5accd62532e3aad3eb
 SHA512:
-  metadata.gz: 3bd03c784efb63a1fb78de007e8b51458f5eb57ce12b3ead22a302e081a370bbc00bee646806cbdb1c1fbef943399862685b55df4a65694bfac41b080cd1f4c1
-  data.tar.gz: 5572d2671311c0406f5b62f38eee4a7064fdf5b970107009207a10b0196989ff20e3a264d0b3fdd62003dfc5800b106076b26da29b129cd2a8c96bc8e8fa8298
+  metadata.gz: bba5622fc180ce5d83f368f418d9c2a730f233de4e0c66f4ca8ef07563471d714fbdc614d6149ecb001fbfbedbe4a128df6417dc8a7c1b9f6687b18e5bcf08fc
+  data.tar.gz: 33ab0de3a1621c4298e98f5e2577c0bcc55becc71cf0d688c59256181edcaac513bf4c04b6c9790dd176878489a4b1bd0de897285e36ed5d1d18ad15dd07289b

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [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,10 +31,30 @@ RBS/Layout/CommentIndentation:
   Description: 'Use 2 spaces for comment indentation'
   Enabled: true
 
-RBS/Layout/EmptyLineAroundOverloads:
+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
+
+RBS/Layout/EmptyLinesAroundInterfaceBody:
+  Description: "Keeps track of empty lines around interface bodies."
+  Enabled: true
+
+RBS/Layout/EmptyLinesAroundModuleBody:
+  Description: "Keeps track of empty lines around module bodies."
+  Enabled: true
+
+RBS/Layout/EmptyLinesAroundOverloads:
   Description: 'No empty line between overload'
   Enabled: true
 
+RBS/Layout/EmptyLines:
+  Description: "Don't use several empty lines in a row."
+  Enabled: true
+
 RBS/Layout/EndAlignment:
   Description: 'Align `end` keyword'
   Enabled: true

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        # Checks for two or more consecutive blank lines.
+        #
+        # @example
+        #
+        #   # bad - It has two empty lines.
+        #   def foo: () -> void
+        #   # one empty line
+        #   # two empty lines
+        #   def bar: () -> void
+        #
+        #   # good
+        #   def foo: () -> void
+        #   # one empty line
+        #   def bar: () -> void
+        #
+        class EmptyLines < RuboCop::RBS::CopBase
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Extra blank line detected.'
+
+          def on_rbs_new_investigation
+            # Quick check if we possibly have consecutive blank lines.
+            return unless processed_source.raw_source.include?("\n\n\n")
+
+            source = processed_source.raw_source
+            pos = 0
+            while index = source.index("\n\n\n", pos)
+              range = range_between(index + 2, index + 3)
+              add_offense(range) do |corrector|
+                corrector.remove(range)
+              end
+              pos = index + 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        module EmptyLinesAroundBody
+          MSG_EXTRA = 'Extra empty line detected at %<kind>s body %<location>s.'
+
+          private
+
+          def check(decl)
+            first_line = decl.location.start_line
+            last_line = decl.location.end_line
+
+            check_beginning(first_line)
+            check_ending(last_line)
+          end
+
+          def check_beginning(first_line)
+            check_source(first_line, 'beginning')
+          end
+
+          def check_ending(last_line)
+            check_source(last_line - 2, 'end')
+          end
+
+          def check_source(line_no, desc)
+            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)
+            add_offense(range, message: message) do |corrector|
+              corrector.remove(range)
+            end
+          end
+
+          def message(type, location)
+            format(type, kind: self.class::KIND, location: location)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        # Checks if empty lines around the bodies of classes match
+        # the configuration.
+        #
+        # @example default
+        #   # good
+        #
+        #   class Foo
+        #     def bar: () -> void
+        #   end
+        class EmptyLinesAroundClassBody < RuboCop::RBS::CopBase
+          include EmptyLinesAroundBody
+          extend AutoCorrector
+
+          KIND = 'class'
+
+          def on_rbs_class(decl)
+            check(decl)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        # Checks if empty lines around the bodies of interfaces match
+        # the configuration.
+        #
+        # @example default
+        #   # good
+        #
+        #   interface _Foo
+        #     def bar: () -> void
+        #   end
+        class EmptyLinesAroundInterfaceBody < RuboCop::RBS::CopBase
+          include EmptyLinesAroundBody
+          extend AutoCorrector
+
+          KIND = 'interface'
+
+          def on_rbs_interface(decl)
+            check(decl)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        # Checks if empty lines around the bodies of modules match
+        # the configuration.
+        #
+        # @example default
+        #   # good
+        #
+        #   module Foo
+        #     def bar: () -> void
+        #   end
+        class EmptyLinesAroundModuleBody < RuboCop::RBS::CopBase
+          include EmptyLinesAroundBody
+          extend AutoCorrector
+
+          KIND = 'module'
+
+          def on_rbs_module(decl)
+            check(decl)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,14 +6,13 @@ module RuboCop
       module Layout
         # @example default
         #   # bad
-        #   class Foo
-        #     def foo: () -> void
-        #     end
+        #   def foo: () -> void
+        #
+        #          | (Integer) -> Integer
         #
         #   # good
-        #   class Foo
-        #     def foo: () -> void
-        #   end
+        #   def foo: () -> void
+        #          | (Integer) -> Integer
         class EmptyLinesAroundOverloads < RuboCop::RBS::CopBase
           extend AutoCorrector
 

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_cops.rb

@@ -3,7 +3,13 @@
 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'
+require_relative 'rbs/layout/empty_lines_around_module_body'
 require_relative 'rbs/layout/empty_lines_around_overloads'
+require_relative 'rbs/layout/empty_lines'
 require_relative 'rbs/layout/end_alignment'
 require_relative 'rbs/layout/extra_spacing'
 require_relative 'rbs/layout/indentation_width'

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 = '0.9.0'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-on-rbs
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.1.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2024-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -66,6 +66,12 @@ files:
 - config/default.yml
 - 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
+- lib/rubocop/cop/rbs/layout/empty_lines_around_module_body.rb
 - lib/rubocop/cop/rbs/layout/empty_lines_around_overloads.rb
 - lib/rubocop/cop/rbs/layout/end_alignment.rb
 - lib/rubocop/cop/rbs/layout/extra_spacing.rb