rubocop-rbs_inline 1.0.0

data/lib/rubocop/cop/style/rbs_inline/unmatched_annotations.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'rbs/inline'
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # IRB::Inline annotations comments for parameters should be matched to the parameters.
+        #
+        # @example
+        #   # bad
+        #   # @rbs unknown: String
+        #   def method(arg); end
+        #
+        #   # good
+        #   # @rbs arg: String
+        #   def method(arg); end
+        #
+        class UnmatchedAnnotations < Base
+          include RangeHelp
+
+          MSG = 'target parameter not found.'
+
+          attr_reader :result #: Array[RBS::Inline::AnnotationParser::ParsingResult]
+
+          def on_new_investigation #: void
+            super
+            @result = parse_comments
+          end
+
+          # @rbs node: Parser::AST::Node
+          def on_def(node) #: void
+            arguments = arguments_for(node)
+
+            comment = result.find { |r| r.comments.map(&:location).map(&:start_line).include? node.location.line - 1 }
+            return unless comment
+
+            result.delete(comment)
+            comment.each_annotation do |annotation|
+              case annotation
+              when RBS::Inline::AST::Annotations::VarType, RBS::Inline::AST::Annotations::BlockType
+                add_offense_for(annotation) unless arguments.include?(annotation_name(annotation))
+              end
+            end
+          end
+
+          def on_investigation_end #: void
+            result.each do |comment|
+              comment.each_annotation do |annotation|
+                case annotation
+                when RBS::Inline::AST::Annotations::VarType
+                  add_offense_for(annotation) unless annotation.name.start_with?('@')
+                when RBS::Inline::AST::Annotations::BlockType, RBS::Inline::AST::Annotations::ReturnType
+                  add_offense_for(annotation)
+                end
+              end
+            end
+
+            super
+          end
+
+          private
+
+          # @rbs node: Parser::AST::Node
+          def arguments_for(node) #: Array[String] # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+            node.children[1].children.flat_map do |argument|
+              name = argument.children[0]&.to_s
+              case argument.type
+              when :arg, :optarg, :kwarg, :kwoptarg
+                [name]
+              when :restarg
+                if name
+                  ["*#{name}", '*']
+                else
+                  ['*']
+                end
+              when :kwrestarg
+                if name
+                  ["**#{name}", '**']
+                else
+                  ['**']
+                end
+              when :blockarg
+                if name
+                  ['&', "&#{name}"]
+                else
+                  ['&', '&block']
+                end
+              end
+            end
+          end
+
+          def parse_comments #: Array[RBS::Inline::AnnotationParser::ParsingResult]
+            parsed_result = Prism.parse(processed_source.buffer.source)
+            RBS::Inline::AnnotationParser.parse(parsed_result.comments)
+          end
+
+          # @rbs annotation: RBS::Inline::AST::Annotations::BlockType |
+          #                  RBS::Inline::AST::Annotations::ReturnType |
+          #                  RBS::Inline::AST::Annotations::VarType
+          def annotation_name(annotation) #: String
+            case annotation
+            when RBS::Inline::AST::Annotations::BlockType
+              "&#{annotation.name}"
+            when RBS::Inline::AST::Annotations::ReturnType
+              'return'
+            else
+              annotation.name.to_s
+            end
+          end
+
+          # @rbs annotation: RBS::Inline::AST::Annotations::BlockType |
+          #                  RBS::Inline::AST::Annotations::ReturnType |
+          #                  RBS::Inline::AST::Annotations::VarType
+          def add_offense_for(annotation) #: void # rubocop:disable Metrics/AbcSize
+            name = annotation_name(annotation)
+            loc = annotation.source.comments.first.location
+            source = processed_source.buffer.source.dup.force_encoding('ASCII')
+            text = source[loc.start_offset...loc.end_offset] or raise
+            comment = text.force_encoding(processed_source.buffer.source.encoding)
+            start_offset = loc.start_offset + (comment.index(name) || 0)
+            range = range_between(character_offset(start_offset), character_offset(start_offset + name.size))
+            add_offense(range)
+          end
+
+          # @rbs byte_offset: Integer
+          def character_offset(byte_offset) #: Integer
+            source = processed_source.buffer.source.dup.force_encoding('ASCII')
+            text = source[...byte_offset] or raise
+            text.force_encoding(processed_source.buffer.source.encoding).size
+          rescue StandardError
+            byte_offset
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rbs_inline/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module RbsInline
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute) # steep:ignore
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/rbs_inline/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RbsInline
+    VERSION = '1.0.0'
+  end
+end

data/lib/rubocop/rbs_inline.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'rbs_inline/version'
+
+module RuboCop
+  module RbsInline
+    class Error < StandardError; end
+    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__ || '').parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-rbs_inline.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/rbs_inline'
+require_relative 'rubocop/rbs_inline/version'
+require_relative 'rubocop/rbs_inline/inject'
+
+RuboCop::RbsInline::Inject.defaults!
+
+require_relative 'rubocop/cop/rbs_inline_cops'

data/rbs_collection.lock.yaml

@@ -0,0 +1,140 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: dbm
+  version: '0'
+  source:
+    type: stdlib
+- name: diff-lcs
+  version: '1.5'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: parser
+  version: '3.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
+- name: prism
+  version: 1.0.0
+  source:
+    type: rubygems
+- name: pstore
+  version: '0'
+  source:
+    type: stdlib
+- name: psych
+  version: '0'
+  source:
+    type: stdlib
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rake
+  version: '13.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rbs
+  version: 3.5.3
+  source:
+    type: rubygems
+- name: rbs-inline
+  version: 0.8.0
+  source:
+    type: rubygems
+- name: rdoc
+  version: '0'
+  source:
+    type: stdlib
+- name: regexp_parser
+  version: '2.8'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rubocop
+  version: '1.57'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rubocop-ast
+  version: '1.30'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: strscan
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: yaml
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,18 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  - name: strscan
+  - name: yaml

data/sig/gems/parser/parser.rbs

@@ -0,0 +1,13 @@
+module Parser
+  module Source
+    class Comment
+      attr_reader text: String
+    end
+
+    class Range
+      attr_reader source_buffer: Buffer
+      attr_reader begin_pos: Integer
+      attr_reader end_pos: Integer
+    end
+  end
+end

data/sig/gems/rubocop/rubocop.rbs

@@ -0,0 +1,29 @@
+module RuboCop
+  module Cop
+    class Base
+      def on_new_investigation: () -> void
+      def on_investigation_end: () -> void
+    end
+
+    module RangeHelp
+      def range_between: (Integer start_pos, Integer end_pos) -> Parser::Source::Range
+    end
+  end
+end
+
+module RuboCop
+  module Ext
+    module Comment
+      def source: () -> String
+      def source_range: () -> Parser::Source::Range
+    end
+  end
+end
+
+module Parser
+  module Source
+    class Comment
+      include RuboCop::Ext::Comment
+    end
+  end
+end

data/sig/rubocop/cop/rbs_inline_cops.rbs

@@ -0,0 +1,2 @@
+# Generated from lib/rubocop/cop/rbs_inline_cops.rb with RBS::Inline
+

data/sig/rubocop/cop/style/rbs_inline/invalid_comment.rbs

@@ -0,0 +1,34 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/invalid_comment.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # IRB::Inline expects annotations comments to start with `#:` or `# @rbs`.
+        # This cop checks for comments that do not match the expected pattern.
+        #
+        # @example
+        #   # bad
+        #   # () -> void
+        #   # : () -> void
+        #   # rbs param: String
+        #
+        #   # good
+        #   #: () -> void
+        #   # @rbs param: String
+        class InvalidComment < Base
+          MSG: ::String
+
+          ANNOTATION_KEYWORDS: Array[String]
+
+          SIGNATURE_PATTERN: ::String
+
+          # refs: https://github.com/soutaro/rbs-inline/blob/main/lib/rbs/inline/annotation_parser/tokenizer.rb
+          RBS_INLINE_KEYWORDS: Array[String]
+
+          def on_new_investigation: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/cop/style/rbs_inline/invalid_types.rbs

@@ -0,0 +1,39 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/invalid_types.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # IRB::Inline expects the types of annotation comments are valid syntax.
+        # This cop checks for comments that do not match the expected pattern.
+        #
+        # @example
+        #   # bad
+        #   # @rbs arg: Hash[Symbol,
+        #   # @rbs &block: String
+        #   def method(arg); end
+        #
+        #   # good
+        #   # @rbs arg: Hash[Symbol, String]
+        #   # @rbs &block: () -> void
+        #   def method(arg); end
+        class InvalidTypes < Base
+          include RangeHelp
+
+          include RBS::Inline::AST::Annotations
+
+          MSG: ::String
+
+          def on_new_investigation: () -> void
+
+          private
+
+          def parse_comments: () -> Array[RBS::Inline::AnnotationParser::ParsingResult]
+
+          # @rbs byte_offset: Integer
+          def character_offset: (Integer byte_offset) -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/cop/style/rbs_inline/keyword_separator.rbs

@@ -0,0 +1,35 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/keyword_separator.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # IRB::Inline expects annotations comments for keywords are not separeted with `:`.
+        # This cop checks for comments that do not match the expected pattern.
+        #
+        # @example
+        #   # bad
+        #   # @rbs module-self: String
+        #
+        #   # good
+        #   # @rbs module-self String
+        class KeywordSeparator < Base
+          include RangeHelp
+
+          MSG: ::String
+
+          # refs: https://github.com/soutaro/rbs-inline/blob/main/lib/rbs/inline/annotation_parser/tokenizer.rb
+          RBS_INLINE_KEYWORDS: Array[String]
+
+          def on_new_investigation: () -> void
+
+          private
+
+          # @rbs comment: Parser::Source::Comment
+          # @rbs matched: MatchData
+          def invalid_location_for: (Parser::Source::Comment comment, MatchData matched) -> Parser::Source::Range
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/cop/style/rbs_inline/parameters_separator.rbs

@@ -0,0 +1,34 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/parameters_separator.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # IRB::Inline expects annotations comments for parameters are separeted with `:`.
+        # This cop checks for comments that do not match the expected pattern.
+        #
+        # @example
+        #   # bad
+        #   # @rbs param String
+        #
+        #   # good
+        #   # @rbs param: String
+        class ParametersSeparator < Base
+          include RangeHelp
+
+          MSG: ::String
+
+          # refs: https://github.com/soutaro/rbs-inline/blob/main/lib/rbs/inline/annotation_parser/tokenizer.rb
+          RBS_INLINE_KEYWORDS: Array[String]
+
+          def on_new_investigation: () -> void
+
+          private
+
+          # @rbs comment: Parser::Source::Comment
+          def invalid_location_for: (Parser::Source::Comment comment) -> Parser::Source::Range
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/cop/style/rbs_inline/unmatched_annotations.rbs

@@ -0,0 +1,54 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/unmatched_annotations.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # IRB::Inline annotations comments for parameters should be matched to the parameters.
+        #
+        # @example
+        #   # bad
+        #   # @rbs unknown: String
+        #   def method(arg); end
+        #
+        #   # good
+        #   # @rbs arg: String
+        #   def method(arg); end
+        class UnmatchedAnnotations < Base
+          include RangeHelp
+
+          MSG: ::String
+
+          attr_reader result: Array[RBS::Inline::AnnotationParser::ParsingResult]
+
+          def on_new_investigation: () -> void
+
+          # @rbs node: Parser::AST::Node
+          def on_def: (Parser::AST::Node node) -> void
+
+          def on_investigation_end: () -> void
+
+          private
+
+          # @rbs node: Parser::AST::Node
+          def arguments_for: (Parser::AST::Node node) -> Array[String]
+
+          def parse_comments: () -> Array[RBS::Inline::AnnotationParser::ParsingResult]
+
+          # @rbs annotation: RBS::Inline::AST::Annotations::BlockType |
+          #                  RBS::Inline::AST::Annotations::ReturnType |
+          #                  RBS::Inline::AST::Annotations::VarType
+          def annotation_name: (RBS::Inline::AST::Annotations::BlockType | RBS::Inline::AST::Annotations::ReturnType | RBS::Inline::AST::Annotations::VarType annotation) -> String
+
+          # @rbs annotation: RBS::Inline::AST::Annotations::BlockType |
+          #                  RBS::Inline::AST::Annotations::ReturnType |
+          #                  RBS::Inline::AST::Annotations::VarType
+          def add_offense_for: (RBS::Inline::AST::Annotations::BlockType | RBS::Inline::AST::Annotations::ReturnType | RBS::Inline::AST::Annotations::VarType annotation) -> void
+
+          # @rbs byte_offset: Integer
+          def character_offset: (Integer byte_offset) -> Integer
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/rbs_inline/inject.rbs

@@ -0,0 +1,13 @@
+# Generated from lib/rubocop/rbs_inline/inject.rb with RBS::Inline
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module RbsInline
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!: () -> untyped
+    end
+  end
+end

data/sig/rubocop/rbs_inline/version.rbs

@@ -0,0 +1,7 @@
+# Generated from lib/rubocop/rbs_inline/version.rb with RBS::Inline
+
+module RuboCop
+  module RbsInline
+    VERSION: ::String
+  end
+end

data/sig/rubocop/rbs_inline.rbs

@@ -0,0 +1,15 @@
+# Generated from lib/rubocop/rbs_inline.rb with RBS::Inline
+
+module RuboCop
+  module RbsInline
+    class Error < StandardError
+    end
+
+    # Your code goes here...
+    PROJECT_ROOT: untyped
+
+    CONFIG_DEFAULT: untyped
+
+    CONFIG: untyped
+  end
+end

data/sig/rubocop-rbs_inline.rbs

@@ -0,0 +1,2 @@
+# Generated from lib/rubocop-rbs_inline.rb with RBS::Inline
+