rubocop-rbs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d4c9bb32e6323c9c18f2b096da62d0e22e18be953d63aaa5604a2dd08861af7
+  data.tar.gz: 9b593cc7039f03b3cc07635fd0b25a465d404289decabe459befe45c1431efa5
+SHA512:
+  metadata.gz: 5f8b812d5aa182a68e3ca9e4da6cc0e48df67b43851f32f0b740a3d1e29c0095b0c6f4d949374c0ff195e8019c7014bcf9b7add13a76473d1b5f5963decd8a13
+  data.tar.gz: 6ffd5e997d7995e223cf9de22b0f56b29b4de840965e84881ac00140f0095c818d6391e42e596508051d19c8a3c24882b040516fc5fd38d0384fd2ea8a6a94b6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mattia Roccoberton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# RuboCop RBS
+
+RucoCop extension that check RBS signatures.
+
+> DISCLAIMER: this extension is an ALPHA version, it could be not 100% stable
+
+Check for:
+- invalid RBS files;
+- missing RBS method signatures;
+- mismatching RBS method signatures arguments.
+
+Please ⭐ if you like it.
+
+**Know limitations**: some IDEs don't update the RBS cops offenses in real-time when a change is applied because only the .rb files are actively monitored.
+
+## Install
+
+- Add to your Gemfile: `gem 'rubocop-rbs'` (and execute bundle)
+
+## Usage
+
+- Execute `rubocop`
+
+To disable the cop:
+
+```yml
+Rbs/MethodSignature:
+  Enabled: false
+```
+
+## Do you like it? Star it!
+
+If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
+
+Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
+
+## Contributors
+
+- [Mattia Roccoberton](https://blocknot.es/): author
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/lib/rubocop/cop/rbs/method_signature.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rbs
+      # Check for:
+      # - invalid RBS files;
+      # - missing RBS method signatures;
+      # - mismatching RBS method signatures arguments.
+      class MethodSignature < Cop
+        MSG = 'signature mismatch'
+
+        def on_def(node)
+          methods = module_methods(node.parent_module_name)
+          return unless methods
+          return add_offense(node, message: 'missing signature') unless methods.key?(node.method_name)
+
+          result = check_arity(node, methods[node.method_name].method_types)
+          add_offense(node, message: result) if result
+        rescue RBS::BaseError => e
+          add_offense(node, message: "signature error, #{e}")
+        end
+        alias on_defs on_def
+
+        private
+
+        def module_methods(module_name)
+          return if module_name.nil?
+
+          type = rbs_resolver.resolve(rbs_type_name(module_name), context: nil)
+          return unless type
+
+          rbs_builder.build_instance(type).methods
+        end
+
+        def rbs_type_name(string)
+          RBS::Namespace.parse(string).yield_self do |namespace|
+            last = namespace.path.last
+            RBS::TypeName.new(name: last, namespace: namespace.parent)
+          end
+        end
+
+        def rbs_environment
+          @@rbs_environment ||= begin
+            loader = RBS::EnvironmentLoader.new
+            loader.add(path: Pathname('sig')) # TODO: use configuration var for sig path
+            RBS::Environment.from_loader(loader).resolve_type_names
+          end
+        end
+
+        def rbs_resolver
+          @@rbs_resolver ||= RBS::Resolver::TypeNameResolver.new(rbs_environment)
+        end
+
+        def rbs_builder
+          @@rbs_builder ||= RBS::DefinitionBuilder.new(env: rbs_environment)
+        end
+
+        def check_arity(node, method_args)
+          arity = node.arguments.entries.map(&:type).tally
+          rbs_args = method_args.first.type
+          return if arity_match?(arity, rbs_args)
+
+          "#{MSG}, expected: #{method_args.join("\n")}"
+        end
+
+        def arity_match?(arity, rbs_args)
+          arity_arg_match?(arity, rbs_args) &&
+            arity_optarg_match?(arity, rbs_args) &&
+            arity_restarg_match?(arity, rbs_args) &&
+            arity_kwarg_match?(arity, rbs_args) &&
+            arity_kwoptarg_match?(arity, rbs_args) &&
+            arity_kwrestarg_match?(arity, rbs_args)
+        end
+
+        def arity_arg_match?(arity, rbs_args)
+          arity[:arg].to_i == rbs_args.required_positionals.count
+        end
+
+        def arity_optarg_match?(arity, rbs_args)
+          arity[:optarg].to_i == rbs_args.optional_positionals.count
+        end
+
+        def arity_restarg_match?(arity, rbs_args)
+          arity[:restarg].to_i.positive? == !rbs_args.rest_positionals.nil?
+        end
+
+        def arity_kwarg_match?(arity, rbs_args)
+          arity[:kwarg].to_i == rbs_args.required_keywords.count
+        end
+
+        def arity_kwoptarg_match?(arity, rbs_args)
+          arity[:kwoptarg].to_i == rbs_args.optional_keywords.count
+        end
+
+        def arity_kwrestarg_match?(arity, rbs_args)
+          arity[:kwrestarg].to_i.positive? == !rbs_args.rest_keywords.nil?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rbs_cops.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'rbs'
+
+require_relative 'rbs/method_signature'

data/lib/rubocop/rbs/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 Rbs
+    # 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)
+        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/version.rb

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

data/lib/rubocop/rbs.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'rbs/version'
+
+module RuboCop
+  module Rbs
+    class Error < StandardError; end
+
+    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.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/rbs'
+require_relative 'rubocop/rbs/version'
+require_relative 'rubocop/rbs/inject'
+
+RuboCop::Rbs::Inject.defaults!
+
+RuboCop::Runner.prepend(Module.new do
+  def file_offense_cache(_file)
+    # NOTE: skip cache because we need to monitor .rbs and their related .rb
+    yield
+  end
+end)
+
+# RuboCop::Config.prepend(Module.new do
+#   def file_to_include?(file)
+#     super || File.extname(file) == '.rbs'
+#   end
+# end)
+
+require_relative 'rubocop/cop/rbs_cops'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rbs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Roccoberton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RuboCop cops to check RBS signatures
+email:
+- mat@blocknot.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- config/default.yml
+- lib/rubocop-rbs.rb
+- lib/rubocop/cop/rbs/method_signature.rb
+- lib/rubocop/cop/rbs_cops.rb
+- lib/rubocop/rbs.rb
+- lib/rubocop/rbs/inject.rb
+- lib/rubocop/rbs/version.rb
+homepage: https://github.com/blocknotes/rubocop-rbs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/blocknotes/rubocop-rbs
+  source_code_uri: https://github.com/blocknotes/rubocop-rbs
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key:
+specification_version: 4
+summary: RuboCop RBS
+test_files: []