rubocop-on-rbs 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05fc386350ef8ab36fc84937e1c3d5f2abdd95e816c8fc4a3ce80f41791475aa
-  data.tar.gz: 5b38f37836d5858ff196abd454bbfa14432ffdca49f8e89cfc88e61490da6d61
+  metadata.gz: 4d260d64881cb68a460632386ff5707ab99717fd56b2ac7ff1824a1cbc55680e
+  data.tar.gz: 353ef7d2b3b583d65880995d4eac7e72cca2f591953a747a826a2c0e55152601
 SHA512:
-  metadata.gz: 4845db99745dab9b0c833fc4bf67e848aab97ed5cbe9e23279d2cf6ff867d100357dac144a261e1af279b415aa49848603a631caac38ea9f4b3a7a2732097001
-  data.tar.gz: e316da95415babf17a4e9d8d59008e6cf9a47ccfef2ed745b90652be9baa76b96c88ace1d0693fa58ea6229dd46282d030413fdbc0c2f649d0db373730903c8d
+  metadata.gz: a77a462af68842c31f3cea245770215819515062faeaf24b6ef5f2d9c87ba0544dbf07f9cd6abc728955d4a67b77fa595baaad3e92c2f3fa7bfb780954a9018b
+  data.tar.gz: 496f22af11da44e34c72c558738a86f1eda45c3afeba5b629d893cf2be6f665b3f477bc8189e32d78e49d5da49e2ce868ce6ab87f4b2652fc4e80fca71764dc4

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.7.0] - 2024-06-27
+
+* Add RBS/Lint/AmbiguousOperatorPrecedence by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/22
+* Add RBS/Lint/UselessAccessModifier by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/23
+
+## [0.6.0] - 2024-06-18
+
+* Fixed problems interfering with other Cop by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/20
+
 ## [0.5.0] - 2024-06-17
 
 * Fix destructive change by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/17

data/config/default.yml

@@ -78,15 +78,18 @@ RBS/Layout/TrailingWhitespace:
 ## RBS/Lint
 
 RBS/Lint:
+  Severity: warning
+  Enabled: true
+
+RBS/Lint/AmbiguousOperatorPrecedence:
+  Description: 'Check ambiguous operator precedence'
   Enabled: true
 
 RBS/Lint/DuplicateOverload:
-  Severity: warning
   Description: 'Checks that there are no repeated overload bodies'
   Enabled: true
 
 RBS/Lint/LiteralIntersection:
-  Severity: warning
   Description: 'Check literal intersection'
   Enabled: true
 
@@ -95,13 +98,16 @@ RBS/Lint/Syntax:
   Description: 'Check RBS syntax'
   Enabled: true
 
+RBS/Lint/UselessAccessModifier:
+  AutoCorrect: contextual
+  Description: 'Check useless access modifier'
+  Enabled: true
+
 RBS/Lint/UselessOverloadTypeParams:
-  Severity: warning
   Description: 'Check redundant overload type params'
   Enabled: true
 
 RBS/Lint/WillSyntaxError:
-  Severity: warning
   Description: 'Check RBS will syntax error'
   Enabled: true
 

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Lint
+        # Checks that there are no repeated overload bodies
+        #
+        # @example default
+        #   # bad
+        #   def foo: (A | B & C) -> void
+        #
+        #   # good
+        #   def foo: (A | (B & C)) -> void
+        #
+        class AmbiguousOperatorPrecedence < RuboCop::RBS::CopBase
+          MSG = 'Wrap expressions with varying precedence with parentheses to avoid ambiguity.'
+
+          extend AutoCorrector
+
+          def on_rbs_def(decl)
+            decl.overloads.each do |overload|
+              overload.method_type.each_type do |type|
+                check_type(type)
+              end
+            end
+          end
+
+          def on_rbs_constant(const)
+            check_type(const.type)
+          end
+          alias on_rbs_global on_rbs_constant
+          alias on_rbs_type_alias on_rbs_constant
+          alias on_rbs_attribute on_rbs_constant
+
+          def check_type(type)
+            on_type([::RBS::Types::Union], type) do |union|
+              union.types.each do |t|
+                case t
+                when ::RBS::Types::Intersection
+                  next unless t.location
+
+                  start_index = bsearch_token_index(t.location.start_pos)
+                  end_index = bsearch_token_index(t.location.end_pos)
+                  before = processed_rbs_source.tokens[start_index - 1]
+                  after = processed_rbs_source.tokens[end_index]
+                  unless before.type == :pLPAREN && after.type == :pRPAREN
+                    range = location_to_range(t.location)
+                    add_offense(range) do |corrector|
+                      corrector.wrap(range, '(', ')')
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          private
+
+          def bsearch_token_index(pos)
+            processed_rbs_source.tokens.bsearch_index do |token|
+              token.location.start_pos >= pos
+            end or raise
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Lint
+        # @example default
+        #   # bad
+        #   class Foo
+        #     public # this is redundant (default access is public)
+        #
+        #     def method: () -> void
+        #   end
+        #
+        #   # bad
+        #   class Foo
+        #     # The following is redundant (methods defined on the class'
+        #     # singleton class are not affected by the private modifier)
+        #     private
+        #
+        #     def self.method3: () -> void
+        #   end
+        #
+        #   # bad
+        #   class Foo
+        #     private # this is redundant (no following methods are defined)
+        #   end
+        #
+        #   # good
+        #   class Foo
+        #     private # this is not redundant (a method is defined)
+        #
+        #     def method2
+        #     end
+        #   end
+        #
+        class UselessAccessModifier < RuboCop::RBS::CopBase
+          extend AutoCorrector
+
+          MSG = 'Useless `%<current>s` access modifier.'
+
+          def on_rbs_class(decl)
+            current = nil
+            unused = true
+            decl.members.each do |member|
+              next unless member.location
+
+              case member
+              when ::RBS::AST::Members::Public
+                if current.nil? || current.is_a?(::RBS::AST::Members::Public)
+                  range = location_to_range(member.location)
+                  add_offense(range, message: format(MSG, { current: 'public' })) do |corrector|
+                    autocorrect(corrector, range)
+                  end
+                end
+                current = member
+              when ::RBS::AST::Members::Private
+                if current.is_a?(::RBS::AST::Members::Private)
+                  range = location_to_range(member.location)
+                  add_offense(range, message: format(MSG, { current: 'private' })) do |corrector|
+                    autocorrect(corrector, range)
+                  end
+                end
+                current = member
+              when ::RBS::AST::Members::MethodDefinition
+                if member.kind != :singleton
+                  unused = false
+                end
+              end
+            end
+
+            if unused && current
+              range = location_to_range(current.location)
+              vis = case current
+                    when ::RBS::AST::Members::Public
+                      'public'
+                    when ::RBS::AST::Members::Private
+                      'private'
+                    end
+              add_offense(range, message: format(MSG, { current: vis })) do |corrector|
+                autocorrect(corrector, range)
+              end
+            end
+          end
+          alias on_rbs_module on_rbs_class
+
+          def autocorrect(corrector, range)
+            line = range_by_whole_lines(range, include_final_newline: true)
+            corrector.remove(line)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,19 +20,27 @@ module RuboCop
               next if overload.method_type.type_params.empty?
 
               type_params = overload.method_type.type_params.dup
+              map = type_params.to_h { |param| [param.name, param] }
+              type_params.each do |type_param|
+                if type_param.upper_bound
+                  used_variable_in_type(type_param.upper_bound) do |var|
+                    map.delete(var.name)
+                  end
+                end
+              end
 
               overload.method_type.each_type do |type|
                 used_variable_in_type(type) do |var|
-                  type_params.delete_if { |type_param| type_param.name == var.name }
+                  map.delete(var.name)
                 end
               end
-              next if type_params.empty?
+              next if map.empty?
 
-              type_params.each do |type_param|
+              map.each do |name, type_param|
                 next unless type_param.location
 
                 t = location_to_range(type_param.location[:name])
-                add_offense(t, message: format(MSG, variable: type_param.name), severity: :warning)
+                add_offense(t, message: format(MSG, variable: name))
               end
             end
           end

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

@@ -72,9 +72,20 @@ module RuboCop
               excludes = [
                 ::RBS::Types::Union,
                 ::RBS::Types::Intersection,
-                ::RBS::Types::Proc
+                ::RBS::Types::Proc,
               ]
               @cop.on_not_type(excludes, @type) do |type|
+                case type
+                when ::RBS::Types::Optional
+                  case type.type
+                  when ::RBS::Types::Literal
+                    case type.type.literal
+                    when Symbol
+                      # Skip optional with symbol literal (e.g. `(:sym)?`)
+                      @skip << type.location.start_pos
+                    end
+                  end
+                end
                 check_parentheses(type)
               end
             end

data/lib/rubocop/cop/rbs_cops.rb

@@ -15,10 +15,12 @@ require_relative 'rbs/layout/space_before_colon'
 require_relative 'rbs/layout/space_before_overload'
 require_relative 'rbs/layout/trailing_whitespace'
 
+require_relative 'rbs/lint/ambiguous_operator_precedence'
 require_relative 'rbs/lint/duplicate_overload'
 require_relative 'rbs/lint/literal_intersection'
-require_relative 'rbs/lint/useless_overload_type_params'
 require_relative 'rbs/lint/syntax'
+require_relative 'rbs/lint/useless_access_modifier'
+require_relative 'rbs/lint/useless_overload_type_params'
 require_relative 'rbs/lint/will_syntax_error'
 
 require_relative 'rbs/style/block_return_boolish'

data/lib/rubocop/rbs/processed_rbs_source.rb

@@ -23,9 +23,11 @@ module RuboCop
         @error.nil?
       end
 
-      def tokens
+      def tokens(with_trivia: false)
         @tokens ||= begin
-          ::RBS::Parser.lex(buffer).value
+          tokens = ::RBS::Parser.lex(buffer).value
+          tokens.reject! { |token| token.type == :tTRIVIA } unless with_trivia
+          tokens
         end
       end
     end

data/lib/rubocop/rbs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-on-rbs
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: '1.61'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: '1.61'
 - !ruby/object:Gem::Dependency
   name: zlib
   requirement: !ruby/object:Gem::Requirement
@@ -77,9 +77,11 @@ files:
 - lib/rubocop/cop/rbs/layout/space_before_colon.rb
 - lib/rubocop/cop/rbs/layout/space_before_overload.rb
 - lib/rubocop/cop/rbs/layout/trailing_whitespace.rb
+- lib/rubocop/cop/rbs/lint/ambiguous_operator_precedence.rb
 - 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/useless_access_modifier.rb
 - lib/rubocop/cop/rbs/lint/useless_overload_type_params.rb
 - lib/rubocop/cop/rbs/lint/will_syntax_error.rb
 - lib/rubocop/cop/rbs/style/block_return_boolish.rb
@@ -120,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: RuboCop extension for RBS file.