rubocop-on-rbs 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d260d64881cb68a460632386ff5707ab99717fd56b2ac7ff1824a1cbc55680e
-  data.tar.gz: 353ef7d2b3b583d65880995d4eac7e72cca2f591953a747a826a2c0e55152601
+  metadata.gz: 8f5b6281c999414ec9c0c147ae2f49e1eb89374b7b159319ae867248305e87be
+  data.tar.gz: dfe65d9221973785fdf15d78fd011e3f3b27410ae329f6830f3f9074f04dc2fe
 SHA512:
-  metadata.gz: a77a462af68842c31f3cea245770215819515062faeaf24b6ef5f2d9c87ba0544dbf07f9cd6abc728955d4a67b77fa595baaad3e92c2f3fa7bfb780954a9018b
-  data.tar.gz: 496f22af11da44e34c72c558738a86f1eda45c3afeba5b629d893cf2be6f665b3f477bc8189e32d78e49d5da49e2ce868ce6ab87f4b2652fc4e80fca71764dc4
+  metadata.gz: 2e3828108b1e14abbbc491f19bb4b9d96211e46449e536ecd64a4b1d2310933e91f5b12ee8ad06b6ffd1dbf45134c2f87d1836868d9a5885072a47fa16018042
+  data.tar.gz: 174bf5a55e04b90c63c0e5d2c3b7164c4be900dd547214e12e67e376077f7c06b6e7c41ee206bfa4f77fe1af59119663f5a85732b6f38241b58467d79252303f

data/config/default.yml

@@ -31,10 +31,26 @@ RBS/Layout/CommentIndentation:
   Description: 'Use 2 spaces for comment indentation'
   Enabled: true
 
-RBS/Layout/EmptyLineAroundOverloads:
+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_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/trailing_whitespace.rb

@@ -22,13 +22,13 @@ module RuboCop
           def on_rbs_new_investigation
             total = 0
             processed_source.raw_source.each_line do |line|
-              total += line.bytesize
+              total += line.length
               chomped = line.chomp
               next unless chomped.end_with?(' ', "\t")
 
               range = range_between(
-                total - line.bytesize + chomped.rstrip.bytesize,
-                total - line.bytesize + chomped.bytesize,
+                total - line.length + chomped.rstrip.length,
+                total - line.length + chomped.length,
               )
               add_offense(range) do |corrector|
                 corrector.remove(range)

data/lib/rubocop/cop/rbs_cops.rb

@@ -3,7 +3,12 @@
 require 'rbs'
 
 require_relative 'rbs/layout/comment_indentation'
+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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-on-rbs
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-06 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -66,6 +66,11 @@ 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_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