rubocop-sorbet 0.6.2 → 0.6.6

data/tasks/cops_documentation.rake

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'yard'
-require 'rubocop'
-require 'rubocop-sorbet'
+require "yard"
+require "rubocop"
+require "rubocop-sorbet"
 
 YARD::Rake::YardocTask.new(:yard_for_generate_documentation) do |task|
-  task.files = ['lib/rubocop/cop/**/*.rb']
-  task.options = ['--no-output']
+  task.files = ["lib/rubocop/cop/**/*.rb"]
+  task.options = ["--no-output"]
 end
 
-desc('Generate docs of all cops departments')
+desc("Generate docs of all cops departments")
 task generate_cops_documentation: :yard_for_generate_documentation do
   def cops_of_department(cops, department)
     cops.with_department(department).sort!
@@ -27,14 +27,14 @@ task generate_cops_documentation: :yard_for_generate_documentation do
   end
 
   def examples(examples_object)
-    examples_object.each_with_object(h3('Examples').dup) do |example, content|
-      content << h4(example.name) unless example.name == ''
+    examples_object.each_with_object(h3("Examples").dup) do |example, content|
+      content << h4(example.name) unless example.name == ""
       content << code_example(example)
     end
   end
 
   def required_ruby_version(cop)
-    return '' unless cop.respond_to?(:required_minimum_ruby_version)
+    return "" unless cop.respond_to?(:required_minimum_ruby_version)
 
     <<~NOTE
       !!! Note
@@ -46,22 +46,22 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def properties(config, cop)
     header = [
-      'Enabled by default', 'Safe', 'Supports autocorrection', 'VersionAdded',
-      'VersionChanged'
+      "Enabled by default", "Safe", "Supports autocorrection", "VersionAdded",
+      "VersionChanged"
     ]
     config = config.for_cop(cop)
-    safe_auto_correct = config.fetch('SafeAutoCorrect', true)
+    safe_auto_correct = config.fetch("SafeAutoCorrect", true)
     autocorrect = if cop.new.support_autocorrect?
-      "Yes #{'(Unsafe)' unless safe_auto_correct}"
+      "Yes #{"(Unsafe)" unless safe_auto_correct}"
     else
-      'No'
+      "No"
     end
     content = [[
-      config.fetch('Enabled') ? 'Enabled' : 'Disabled',
-      config.fetch('Safe', true) ? 'Yes' : 'No',
+      config.fetch("Enabled") ? "Enabled" : "Disabled",
+      config.fetch("Safe", true) ? "Yes" : "No",
       autocorrect,
-      config.fetch('VersionAdded', '-'),
-      config.fetch('VersionChanged', '-'),
+      config.fetch("VersionAdded", "-"),
+      config.fetch("VersionChanged", "-"),
     ]]
     to_table(header, content) + "\n"
   end
@@ -89,23 +89,23 @@ task generate_cops_documentation: :yard_for_generate_documentation do
   def code_example(ruby_code)
     content = +"```ruby\n"
     content << ruby_code.text
-      .gsub('@good', '# good').gsub('@bad', '# bad').strip
+      .gsub("@good", "# good").gsub("@bad", "# bad").strip
     content << "\n```\n"
     content
   end
 
   def configurations(pars)
-    return '' if pars.empty?
+    return "" if pars.empty?
 
-    header = ['Name', 'Default value', 'Configurable values']
-    configs = pars.each_key.reject { |key| key.start_with?('Supported') }
+    header = ["Name", "Default value", "Configurable values"]
+    configs = pars.each_key.reject { |key| key.start_with?("Supported") }
     content = configs.map do |name|
       configurable = configurable_values(pars, name)
       default = format_table_value(pars[name])
       [name, default, configurable]
     end
 
-    h3('Configurable attributes') + to_table(header, content)
+    h3("Configurable attributes") + to_table(header, content)
   end
 
   def configurable_values(pars, name)
@@ -113,24 +113,24 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     when /^Enforced/
       supported_style_name = RuboCop::Cop::Util.to_supported_styles(name)
       format_table_value(pars[supported_style_name])
-    when 'IndentationWidth'
-      'Integer'
-    when 'Database'
-      format_table_value(pars['SupportedDatabases'])
+    when "IndentationWidth"
+      "Integer"
+    when "Database"
+      format_table_value(pars["SupportedDatabases"])
     else
       case pars[name]
       when String
-        'String'
+        "String"
       when Integer
-        'Integer'
+        "Integer"
       when Float
-        'Float'
+        "Float"
       when true, false
-        'Boolean'
+        "Boolean"
       when Array
-        'Array'
+        "Array"
       else
-        ''
+        ""
       end
     end
   end
@@ -138,10 +138,10 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def to_table(header, content)
     table = [
-      header.join(' | '),
-      Array.new(header.size, '---').join(' | '),
+      header.join(" | "),
+      Array.new(header.size, "---").join(" | "),
     ]
-    table.concat(content.map { |c| c.join(' | ') })
+    table.concat(content.map { |c| c.join(" | ") })
     table.join("\n") + "\n"
   end
 
@@ -150,14 +150,14 @@ task generate_cops_documentation: :yard_for_generate_documentation do
       case val
       when Array
         if val.empty?
-          '`[]`'
+          "`[]`"
         else
-          val.map { |config| format_table_value(config) }.join(', ')
+          val.map { |config| format_table_value(config) }.join(", ")
         end
       else
-        "`#{val.nil? ? '<none>' : val}`"
+        "`#{val.nil? ? "<none>" : val}`"
       end
-    value.gsub("#{Dir.pwd}/", '').rstrip
+    value.gsub("#{Dir.pwd}/", "").rstrip
   end
 
   def references(config, cop)
@@ -165,9 +165,9 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     urls = RuboCop::Cop::MessageAnnotator.new(
       config, cop.name, cop_config, {}
     ).urls
-    return '' if urls.empty?
+    return "" if urls.empty?
 
-    content = h3('References')
+    content = h3("References")
     content << urls.map { |url| "* [#{url}](#{url})" }.join("\n")
     content << "\n"
     content
@@ -175,7 +175,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def print_cops_of_department(cops, department, config)
     selected_cops = cops_of_department(cops, department).select do |cop|
-      cop.to_s.start_with?('RuboCop::Cop::Sorbet')
+      cop.to_s.start_with?("RuboCop::Cop::Sorbet")
     end
     return if selected_cops.empty?
 
@@ -184,7 +184,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
       content << print_cop_with_doc(cop, config)
     end
     file_name = "#{Dir.pwd}/manual/cops_#{department.downcase}.md"
-    File.open(file_name, 'w') do |file|
+    File.open(file_name, "w") do |file|
       puts "* generated #{file_name}"
       file.write(content.strip + "\n")
     end
@@ -192,25 +192,23 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def print_cop_with_doc(cop, config)
     t = config.for_cop(cop)
-    non_display_keys = %w[
-      Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
-      VersionChanged
-    ]
+    non_display_keys = ["Description", "Enabled", "StyleGuide", "Reference", "Safe", "SafeAutoCorrect", "VersionAdded",
+                        "VersionChanged"]
     pars = t.reject { |k| non_display_keys.include?(k) }
-    description = 'No documentation'
+    description = "No documentation"
     examples_object = []
     YARD::Registry.all(:class).detect do |code_object|
       next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge
 
       description = code_object.docstring unless code_object.docstring.blank?
-      examples_object = code_object.tags('example')
+      examples_object = code_object.tags("example")
     end
     cops_body(config, cop, description, examples_object, pars)
   end
 
   def table_of_content_for_department(cops, department)
     selected_cops = cops_of_department(cops, department.to_sym).select do |cop|
-      cop.to_s.start_with?('RuboCop::Cop::Sorbet')
+      cop.to_s.start_with?("RuboCop::Cop::Sorbet")
     end
     return if selected_cops.empty?
 
@@ -218,7 +216,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     filename = "cops_#{department.downcase}.md"
     content = +"#### Department [#{type_title}](#{filename})\n\n"
     selected_cops.each do |cop|
-      anchor = cop.cop_name.sub('/', '').downcase
+      anchor = cop.cop_name.sub("/", "").downcase
       content << "* [#{cop.cop_name}](#{filename}##{anchor})\n"
     end
 
@@ -256,21 +254,21 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def assert_manual_synchronized
     # Do not print diff and yield whether exit code was zero
-    sh('git diff --quiet manual') do |outcome, _|
+    sh("git diff --quiet manual") do |outcome, _|
       return if outcome
 
       # Output diff before raising error
-      sh('GIT_PAGER=cat git diff manual')
+      sh("GIT_PAGER=cat git diff manual")
 
-      warn 'The manual directory is out of sync. ' \
-        'Run `rake generate_cops_documentation` and commit the results.'
+      warn("The manual directory is out of sync. " \
+        "Run `rake generate_cops_documentation` and commit the results.")
       exit!
     end
   end
 
   def main
     cops   = RuboCop::Cop::Cop.registry
-    config = RuboCop::ConfigLoader.load_file('config/default.yml')
+    config = RuboCop::ConfigLoader.load_file("config/default.yml")
 
     YARD::Registry.load!
     cops.departments.sort!.each do |department|
@@ -279,7 +277,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
     print_table_of_contents(cops)
 
-    assert_manual_synchronized if ENV['CI'] == 'true'
+    assert_manual_synchronized if ENV["CI"] == "true"
   ensure
     RuboCop::ConfigLoader.default_configuration = nil
   end
@@ -287,9 +285,9 @@ task generate_cops_documentation: :yard_for_generate_documentation do
   main
 end
 
-desc('Syntax check for the documentation comments')
+desc("Syntax check for the documentation comments")
 task documentation_syntax_check: :yard_for_generate_documentation do
-  require 'parser/ruby25'
+  require "parser/ruby25"
 
   ok = true
   YARD::Registry.load!
@@ -298,11 +296,11 @@ task documentation_syntax_check: :yard_for_generate_documentation do
     examples = YARD::Registry.all(:class).find do |code_object|
       next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge
 
-      break code_object.tags('example')
+      break code_object.tags("example")
     end
 
     examples.to_a.each do |example|
-      buffer = Parser::Source::Buffer.new('<code>', 1)
+      buffer = Parser::Source::Buffer.new("<code>", 1)
       buffer.source = example.text
       parser = Parser::Ruby25.new(RuboCop::AST::Builder.new)
       parser.diagnostics.all_errors_are_fatal = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.6
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,30 +31,30 @@ dependencies:
   name: unparser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.90.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.90.0
 description: 
 email:
 - ruby@shopify.com
@@ -64,6 +64,7 @@ extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
 - ".github/probots.yml"
+- ".github/release.yml"
 - ".github/stale.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
@@ -81,6 +82,7 @@ files:
 - bin/rubocop
 - bin/setup
 - config/default.yml
+- config/rbi.yml
 - dev.yml
 - lib/rubocop-sorbet.rb
 - lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb
@@ -92,9 +94,10 @@ files:
 - lib/rubocop/cop/sorbet/forbid_untyped_struct_props.rb
 - lib/rubocop/cop/sorbet/one_ancestor_per_line.rb
 - lib/rubocop/cop/sorbet/rbi/forbid_extend_t_sig_helpers_in_shims.rb
-- lib/rubocop/cop/sorbet/rbi/forbid_rbi_outside_of_sorbet_dir.rb
+- lib/rubocop/cop/sorbet/rbi/forbid_rbi_outside_of_allowed_paths.rb
 - lib/rubocop/cop/sorbet/rbi/single_line_rbi_class_module_definitions.rb
 - lib/rubocop/cop/sorbet/sigils/enforce_sigil_order.rb
+- lib/rubocop/cop/sorbet/sigils/enforce_single_sigil.rb
 - lib/rubocop/cop/sorbet/sigils/false_sigil.rb
 - lib/rubocop/cop/sorbet/sigils/has_sigil.rb
 - lib/rubocop/cop/sorbet/sigils/ignore_sigil.rb
@@ -106,9 +109,9 @@ files:
 - lib/rubocop/cop/sorbet/signatures/checked_true_in_signature.rb
 - lib/rubocop/cop/sorbet/signatures/enforce_signatures.rb
 - lib/rubocop/cop/sorbet/signatures/keyword_argument_ordering.rb
-- lib/rubocop/cop/sorbet/signatures/parameters_ordering_in_signature.rb
 - lib/rubocop/cop/sorbet/signatures/signature_build_order.rb
 - lib/rubocop/cop/sorbet/signatures/signature_cop.rb
+- lib/rubocop/cop/sorbet/type_alias_name.rb
 - lib/rubocop/cop/sorbet_cops.rb
 - lib/rubocop/sorbet.rb
 - lib/rubocop/sorbet/inject.rb
@@ -141,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.

data/lib/rubocop/cop/sorbet/rbi/forbid_rbi_outside_of_sorbet_dir.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sorbet
-      # This cop makes sure that RBI files are always located under sorbet/rbi/.
-      #
-      # @example
-      #   # bad
-      #   lib/some_file.rbi
-      #   other_file.rbi
-      #
-      #   # good
-      #   sorbet/rbi/some_file.rbi
-      #   sorbet/rbi/any/path/for/file.rbi
-      class ForbidRBIOutsideOfSorbetDir < RuboCop::Cop::Cop
-        include RangeHelp
-
-        PATH_REGEXP = %r{sorbet/rbi}
-
-        def investigate(processed_source)
-          add_offense(
-            nil,
-            location: source_range(processed_source.buffer, 1, 0),
-            message: "RBI files are only accepted in the sorbet/rbi/ directory."
-          ) unless processed_source.file_path =~ PATH_REGEXP
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/cop/sorbet/signatures/parameters_ordering_in_signature.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-require_relative 'signature_cop'
-
-module RuboCop
-  module Cop
-    module Sorbet
-      # This cop checks for inconsistent ordering of parameters between the
-      # signature and the method definition. The sorbet-runtime gem raises
-      # when such inconsistency occurs.
-      #
-      # @example
-      #
-      #   # bad
-      #   sig { params(a: Integer, b: String).void }
-      #   def foo(b:, a:); end
-      #
-      #   # good
-      #   sig { params(a: Integer, b: String).void }
-      #   def foo(a:, b:); end
-      class ParametersOrderingInSignature < SignatureCop
-        def_node_search(:signature_params, <<-PATTERN)
-          (send _ :params ...)
-        PATTERN
-
-        def on_signature(node)
-          sig_params = signature_params(node).first
-
-          sig_params_order = extract_parameters(sig_params)
-          return if sig_params_order.nil?
-          method_node = node.parent.children[node.sibling_index + 1]
-          return if method_node.nil? || method_node.type != :def
-          method_parameters = method_node.arguments
-
-          check_for_inconsistent_param_ordering(sig_params_order, method_parameters)
-        end
-
-        private
-
-        def extract_parameters(sig_params)
-          return [] if sig_params.nil?
-
-          arguments = sig_params.arguments.first
-          return arguments.keys.map(&:value) if RuboCop::AST::HashNode === arguments
-
-          add_offense(
-            sig_params,
-            message: "Invalid signature."
-          )
-        end
-
-        def check_for_inconsistent_param_ordering(sig_params_order, parameters)
-          parameters.each_with_index do |param, index|
-            param_name = param.children[0]
-            sig_param_name = sig_params_order[index]
-
-            next if param_name == sig_param_name
-
-            add_offense(
-              param,
-              message: "Inconsistent ordering of arguments at index #{index}. " \
-              "Expected `#{sig_param_name}` from sig above."
-            )
-          end
-        end
-      end
-    end
-  end
-end