rubocop-sorbet 0.3.6 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a92716b1864cc9e66f6c3dcadb78aed34de2c23d9bcaa201f5ee7cc8f9a5cbc
-  data.tar.gz: 57ffe424d24b7ab58cea383f6f05f2f30a726e8aa6dbf0a87989bbd219276bcc
+  metadata.gz: 0df763a5f1ab8de8024c732f5e3fae7d31d21e13c807fceca5c0d8c674e52d46
+  data.tar.gz: 36fb28afefdb665eb471bb536be012b5123efe5e19ef1ddf61415c21a6aa5892
 SHA512:
-  metadata.gz: bea0851da95265e63fdfa0d33418f34ff7189fc778d3ad8aa6ef0e51f4af1b8f1aebdd514d678ad7affb71e06fe0607630b6019a43380d9c60396b092e5ad4fc
-  data.tar.gz: c270ac5e4576d7f0d214e8d605356e93bb820dbab2f5062fc6ec7261eeb2437354c9326951704b40c2b0911dd41cf913220c5d848c21ede41976c9956772056d
+  metadata.gz: 80f5462984070d3194ad111484b5a4f40905b9ba65ab55f95b050915a8df7fa2c2e54d30a7771738f7bb5e9c26dac8568c36a90c3e854dabb14240b255759c64
+  data.tar.gz: 66ed0ca23fa3b76a372fdae99273af7e037e3f0de5b437fc8a4d35ad024da31d0cd174c0afb12c0176c8b111d2b73be7be9960611f9176d58d46825e5c702015

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Request a review from @Shopify/sorbet when a new PR is created
+* @Shopify/sorbet

data/.github/probots.yml

@@ -1,3 +1,3 @@
 enabled:
   - cla
-
+  - probot-stale

data/.github/stale.yml

@@ -0,0 +1,20 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 30
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This PR has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false
+#
+only: pulls
+#

data/.gitignore

@@ -6,5 +6,3 @@
 /pkg/
 /spec/reports/
 /tmp/
-
-.rubocop-https--*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,23 +1,13 @@
 # This file strictly follows the rules defined in the Ruby style guide:
 #   http://shopify.github.io/ruby-style-guide/
-inherit_from:
-  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+  rubocop-shopify: rubocop.yml
 
 AllCops:
   TargetRubyVersion: 2.5
   Exclude:
     - vendor/**/*
 
-Naming/AccessorMethodName:
-  Enabled: false
-
-require:
-  - rubocop-sorbet
-
 Naming/FileName:
   Exclude:
   - lib/rubocop-sorbet.rb
-
-Lint/HandleExceptions:
-  Exclude:
-  - Rakefile

data/.travis.yml

@@ -3,7 +3,9 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.2
+  - 2.5
+  - 2.6
+  - 2.7
 before_install: gem install bundler -v 1.17.3
 script:
   - bundle exec rubocop --config .rubocop.yml

data/Gemfile

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
-
-source('https://rubygems.org')
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-group(:deployment) do
-  gem('package_cloud', '~> 0.3.05')
-end
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in rubocop-sorbet.gemspec
 gemspec
+
+gem "rake", ">= 12.3.3"
+gem "rspec"
+gem "rubocop-shopify", require: false
+gem "yard", "~> 0.9"

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.3.6)
+    rubocop-sorbet (0.5.1)
+      rubocop
 
 GEM
   remote: https://rubygems.org/
@@ -15,38 +16,18 @@ GEM
       adamantium (~> 0.2.0)
       equalizer (~> 0.0.9)
     diff-lcs (1.3)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
     equalizer (0.0.11)
-    highline (1.6.20)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
     ice_nine (0.11.2)
-    jaro_winkler (1.5.3)
-    json_pure (1.8.1)
     memoizable (0.4.2)
       thread_safe (~> 0.3, >= 0.3.1)
-    mime-types (3.2.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
-    netrc (0.11.0)
-    package_cloud (0.3.05)
-      highline (= 1.6.20)
-      json_pure (= 1.8.1)
-      rainbow (= 2.2.2)
-      rest-client (~> 2.0)
-      thor (~> 0.18)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
     procto (0.0.3)
-    rainbow (2.2.2)
-      rake
-    rake (12.3.2)
-    rest-client (2.0.2)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.0)
+    rexml (3.2.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -60,38 +41,42 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
-    rubocop (0.72.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.85.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-shopify (1.0.3)
+      rubocop (~> 0.85.0)
     ruby-progressbar (1.10.1)
-    thor (0.20.3)
     thread_safe (0.3.6)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.6)
-    unicode-display_width (1.6.0)
-    unparser (0.4.5)
+    unicode-display_width (1.7.0)
+    unparser (0.4.7)
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2.0)
       concord (~> 0.1.5)
       diff-lcs (~> 1.3)
       equalizer (~> 0.0.9)
-      parser (~> 2.6.3)
+      parser (>= 2.6.5)
       procto (~> 0.0.2)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  package_cloud (~> 0.3.05)
-  rspec (~> 3.7)
-  rubocop (~> 0.57)
+  rake (>= 12.3.3)
+  rspec
+  rubocop-shopify
   rubocop-sorbet!
-  unparser (~> 0.4.2)
+  unparser
+  yard (~> 0.9)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -6,29 +6,87 @@ A collection of Rubocop rules for Sorbet.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Just install the `rubocop-sorbet` gem
+
+```sh
+gem install rubocop-sorbet
+```
+or, if you use `Bundler`, add this line your application's `Gemfile`:
 
 ```ruby
-gem 'rubocop-sorbet'
+gem 'rubocop-sorbet', require: false
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+You need to tell RuboCop to load the Sorbet extension. There are three ways to do this:
 
-## Usage
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`:
+
+```yaml
+require: rubocop-sorbet
+```
 
-And add this to your `.rubocop.yml` file:
+Alternatively, use the following array notation when specifying multiple extensions:
 
 ```yaml
 require:
+  - rubocop-other-extension
   - rubocop-sorbet
 ```
 
+Now you can run `rubocop` and it will automatically load the RuboCop Sorbet cops together with the standard cops.
+
+### Command line
+
+```sh
+rubocop --require rubocop-sorbet
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-sorbet'
+end
+```
+
+## The Cops
+All cops are located under [`lib/rubocop/cop/sorbet`](lib/rubocop/cop/sorbet), and contain examples/documentation.
+
+In your `.rubocop.yml`, you may treat the Sorbet cops just like any other cop. For example:
+
+```yaml
+Sorbet/FalseSigil:
+  Exclude:
+    - lib/example.rb
+```
+
+## Documentation
+
+You can read about each cop supplied by RuboCop Sorbet in [the manual](manual/cops.md).
+
+## Compatibility
+
+Sorbet cops support the following versions:
+
+- Sorbet >= 0.5
+- Ruby >= 2.5
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/rubocop-sorbet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+To contribute a new cop, please use the supplied generator like this:
+
+```sh
+bundle exec rake new_cop[Sorbet/NewCopName]
+```
+
+which will create a skeleton cop, a skeleton spec, an entry in the default config file and will require the new cop so that it is properly exported from the gem.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://github.com/Shopify/rubocop-sorbet/blob/master/LICENSE.txt).

data/Rakefile

@@ -2,10 +2,39 @@
 
 require('bundler/gem_tasks')
 
-begin
-  require('rspec/core/rake_task')
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task(default: :spec)
+task(default: %i[
+  documentation_syntax_check
+  generate_cops_documentation
+  spec
+])
+
+desc('Generate a new cop with a template')
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  github_user = %x(git config github.user).chop
+  github_user = 'Shopify' if github_user.empty?
+
+  generator = RuboCop::Cop::Generator.new(cop_name, github_user)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/sorbet_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/config/default.yml

@@ -1,6 +1,128 @@
-Sorbet/ValidSigil:
+inherit_mode:
+  merge:
+  - Exclude
+
+Sorbet/AllowIncompatibleOverride:
+  Description: 'Disallows using `.override(allow_incompatible: true)`.'
+  Enabled: true
+  VersionAdded: 0.2.0
+
+Sorbet/BindingConstantWithoutTypeAlias:
+  Description: >-
+                  Disallows binding the return value of `T.any`, `T.all`, `T.enum`
+                  to a constant directly. To bind the value, one must use `T.type_alias`.
+  Enabled: true
+  VersionAdded: 0.2.0
+
+Sorbet/CheckedTrueInSignature:
+  Description: 'Disallows the usage of `checked(true)` in signatures.'
+  Enabled: true
+  VersionAdded: 0.2.0
+
+Sorbet/ConstantsFromStrings:
+  Description: >-
+                  Forbids constant access through meta-programming.
+
+                  For example, things like `constantize` or `const_get`
+                  are forbidden.
+  Enabled: true
+  VersionAdded: 0.2.0
+
+Sorbet/EnforceSigilOrder:
+  Description: 'Ensures that Sorbet sigil comes first in a file.'
   Enabled: true
-  EnforcedStyle: typed_files
+  VersionAdded: 0.3.4
 
 Sorbet/EnforceSignatures:
+  Description: 'Ensures all methods have a valid signature.'
+  Enabled: false
+  VersionAdded: 0.3.4
+
+Sorbet/FalseSigil:
+  Description: 'All files must be at least at strictness `false`.'
+  Enabled: true
+  VersionAdded: 0.3.3
+  SuggestedStrictness: true
+  Include:
+  - "**/*.rb"
+  - "**/*.rbi"
+  - "**/*.rake"
+  - "**/*.ru"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
+
+Sorbet/ForbidIncludeConstLiteral:
+  Description: 'Forbids include of non-literal constants.'
+  Enabled: false
+  VersionAdded: 0.2.0
+  VersionChanged: 0.5.0
+
+Sorbet/ForbidSuperclassConstLiteral:
+  Description: 'Forbid superclasses which are non-literal constants.'
+  Enabled: false
+  VersionAdded: 0.2.0
+  VersionChanged: 0.5.0
+
+Sorbet/ForbidUntypedStructProps:
+  Description: >-
+                  Disallows use of `T.untyped` or `T.nilable(T.untyped)` as a
+                  prop type for `T::Struct` subclasses.
+  Enabled: true
+  VersionAdded: 0.4.0
+
+Sorbet/HasSigil:
+  Description: 'Makes the Sorbet typed sigil mandatory in all files.'
+  Enabled: false
+  VersionAdded: 0.3.3
+
+Sorbet/IgnoreSigil:
+  Description: 'All files must be at least at strictness `ignore`.'
+  Enabled: false
+  VersionAdded: 0.3.3
+
+Sorbet/KeywordArgumentOrdering:
+  Description: >-
+                  Enforces a compatible keyword arguments with Sorbet.
+
+                  All keyword arguments must be at the end of the parameters
+                  list, and all keyword arguments with a default value must be
+                  after those without default values.
+  Enabled: true
+  VersionAdded: 0.2.0
+
+Sorbet/ParametersOrderingInSignature:
+  Description: 'Enforces same parameter order between a method and its signature.'
+  Enabled: true
+  VersionAdded: 0.2.0
+
+Sorbet/SignatureBuildOrder:
+  Description: >-
+                  Enforces the order of parts in a signature.
+
+                  The order is first inheritance related builders,
+                  then params, then return and finally the modifier
+                  such as: `abstract.params(...).returns(...).soft`.'
+  Enabled: true
+  VersionAdded: 0.3.0
+
+Sorbet/StrictSigil:
+  Description: 'All files must be at least at strictness `strict`.'
+  Enabled: false
+  VersionAdded: 0.3.3
+
+Sorbet/StrongSigil:
+  Description: 'All files must be at least at strictness `strong`.'
+  Enabled: false
+  VersionAdded: 0.3.3
+
+Sorbet/TrueSigil:
+  Description: 'All files must be at least at strictness `true`.'
+  Enabled: false
+  VersionAdded: 0.3.3
+
+Sorbet/ValidSigil:
+  Description: 'All files must have a valid sigil.'
   Enabled: true
+  VersionAdded: 0.3.3