rubocop-sorbet 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7baa291ded0aa343c64c841b2d03cf91d52ad07071883a680f8b725297d0d8e9
-  data.tar.gz: 95e36584da91cccee6423d2d65fcc061ea74e1abfc51c4c5fb1a18f8b1878e62
+  metadata.gz: c8e5d981eb3753f8e4a5599105ffca85878383e8c9babe36126529d13408c578
+  data.tar.gz: 19162fbc227c9d40774bec276129f739ee885201bb688b74cd3a7901253770ac
 SHA512:
-  metadata.gz: 2d3772bb095eed330fbab2f2ff723f932bc4b40a175738532e043c6fbb66c9c2116a9435b4b210cf2b0f59dc3b8be889da976293db38f6e42f583be9dd8ddb26
-  data.tar.gz: 04a54d3d285223f71d48f4a164ec69124ce9b45d74eba3c7232abd6388e9638acb3e8fada94f2f88533432e51077d03952037d1828850261e623797dacd7b9a5
+  metadata.gz: fd590134345de1400d2c653b263d2b0936aa1f02f6e199fc5d2f65eca50b37aef77df4d4463afe403ca7ba3f795dd389a72164d62c796dc943fb108e4eef76df
+  data.tar.gz: 4b5caba384adc3a2b45e8532cd1dba357bf7404d577da3a24defb9279a903a7b1c02bb1efdd28571517cab33ba3fa01dde88b1319da8cd8d051ecb308cd9d8b5

data/.rubocop.yml

@@ -6,7 +6,6 @@ inherit_from:
 AllCops:
   TargetRubyVersion: 2.5
   Exclude:
-    - lib/waffle_cone/rbi_compilers/yard_type_parser.rb
     - vendor/**/*
 
 Naming/AccessorMethodName:
@@ -19,9 +18,6 @@ Naming/FileName:
   Exclude:
   - lib/rubocop-sorbet.rb
 
-Style/StringLiterals:
-  EnforcedStyle: single_quotes
-
 Lint/HandleExceptions:
   Exclude:
   - Rakefile

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.3.2)
+    rubocop-sorbet (0.3.3)
 
 GEM
   remote: https://rubygems.org/

data/config/default.yml

@@ -1,3 +1,3 @@
-Sorbet/ValidSorbetSigil:
+Sorbet/ValidSigil:
   Enabled: true
   EnforcedStyle: typed_files

data/lib/rubocop/cop/sorbet/sigils/false_sigil.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative 'has_sigil'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop makes the Sorbet `false` sigil mandatory in all files.
+      class FalseSigil < HasSigil
+        def minimum_strictness
+          'false'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/sigils/has_sigil.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative 'valid_sigil'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop makes the Sorbet typed sigil mandatory in all files.
+      #
+      # Options:
+      #
+      # * `SuggestedStrictness`: Sorbet strictness level suggested in offense messages (default: 'false')
+      # * `MinimumStrictness`: If set, make offense if the strictness level in the file is below this one
+      #
+      # If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
+      class HasSigil < ValidSigil
+        @registry = Cop.registry # So we can properly subclass this cop
+
+        def require_sigil_on_all_files?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/sigils/ignore_sigil.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative 'has_sigil'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop makes the Sorbet `ignore` sigil mandatory in all files.
+      class IgnoreSigil < HasSigil
+        def minimum_strictness
+          'ignore'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/sigils/strict_sigil.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative 'has_sigil'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop makes the Sorbet `strict` sigil mandatory in all files.
+      class StrictSigil < HasSigil
+        def minimum_strictness
+          'strict'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/sigils/strong_sigil.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative 'has_sigil'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop makes the Sorbet `strong` sigil mandatory in all files.
+      class StrongSigil < HasSigil
+        def minimum_strictness
+          'strong'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/sigils/true_sigil.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative 'has_sigil'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop makes the Sorbet `true` sigil mandatory in all files.
+      class TrueSigil < HasSigil
+        def minimum_strictness
+          'true'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/sigils/valid_sigil.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop checks that every Ruby file contains a valid Sorbet sigil.
+      # Adapted from: https://gist.github.com/clarkdave/85aca4e16f33fd52aceb6a0a29936e52
+      #
+      # Options:
+      #
+      # * `RequireSigilOnAllFiles`: make offense if the Sorbet typed is not found in the file (default: false)
+      # * `SuggestedStrictness`: Sorbet strictness level suggested in offense messages (default: 'false')
+      # * `MinimumStrictness`: If set, make offense if the strictness level in the file is below this one
+      #
+      # If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
+      class ValidSigil < RuboCop::Cop::Cop
+        @registry = Cop.registry # So we can properly subclass this cop
+
+        def investigate(processed_source)
+          return if processed_source.tokens.empty?
+
+          sigil = extract_sigil(processed_source)
+          return unless check_sigil_present(sigil)
+
+          strictness = extract_strictness(sigil)
+          return unless check_strictness_not_empty(sigil, strictness)
+          return unless check_strictness_valid(sigil, strictness)
+          return unless check_strictness_level(sigil, strictness)
+        end
+
+        def autocorrect(_node)
+          lambda do |corrector|
+            return unless require_sigil_on_all_files?
+            return unless extract_sigil(processed_source).nil?
+
+            token = processed_source.tokens.first
+            corrector.insert_before(token.pos, "# typed: #{minimum_strictness || suggested_strictness}\n")
+          end
+        end
+
+        protected
+
+        STRICTNESS_LEVELS = %w(ignore false true strict strong)
+        SIGIL_REGEX = /#\s+typed:(?:\s+([\w]+))?/
+
+        # extraction
+
+        def extract_sigil(processed_source)
+          processed_source.tokens
+            .take_while { |token| token.type == :tCOMMENT }
+            .find { |token| SIGIL_REGEX.match?(token.text) }
+        end
+
+        def extract_strictness(sigil)
+          sigil.text.match(SIGIL_REGEX)&.captures&.first
+        end
+
+        # checks
+
+        def check_sigil_present(sigil)
+          return true unless sigil.nil?
+
+          token = processed_source.tokens.first
+          if require_sigil_on_all_files?
+            strictness = minimum_strictness || suggested_strictness
+            add_offense(
+              token,
+              location: token.pos,
+              message: 'No Sorbet sigil found in file. ' \
+                "Try a `typed: #{strictness}` to start (you can also use `rubocop -a` to automatically add this)."
+            )
+          end
+          false
+        end
+
+        def check_strictness_not_empty(sigil, strictness)
+          return true if strictness
+
+          add_offense(
+            sigil,
+            location: sigil.pos,
+            message: 'Sorbet sigil should not be empty.'
+          )
+          false
+        end
+
+        def check_strictness_valid(sigil, strictness)
+          return true if STRICTNESS_LEVELS.include?(strictness)
+
+          add_offense(
+            sigil,
+            location: sigil.pos,
+            message: "Invalid Sorbet sigil `#{strictness}`."
+          )
+          false
+        end
+
+        def check_strictness_level(sigil, strictness)
+          return true unless minimum_strictness
+
+          minimum_level = STRICTNESS_LEVELS.index(minimum_strictness)
+          current_level = STRICTNESS_LEVELS.index(strictness)
+          if current_level < minimum_level
+            add_offense(
+              sigil,
+              location: sigil.pos,
+              message: "Sorbet sigil should be at least `#{minimum_strictness}` got `#{strictness}`."
+            )
+            return false
+          end
+          true
+        end
+
+        # options
+
+        # Default is `false`
+        def require_sigil_on_all_files?
+          !!cop_config['RequireSigilOnAllFiles']
+        end
+
+        # Default is `'false'`
+        def suggested_strictness
+          cop_config['SuggestedStrictness'] || 'false'
+        end
+
+        # Default is `nil`
+        def minimum_strictness
+          cop_config['MinimumStrictness']
+        end
+      end
+    end
+  end
+end

data/lib/rubocop_sorbet.rb

@@ -9,4 +9,11 @@ require_relative 'rubocop/cop/sorbet/forbid_superclass_const_literal'
 require_relative 'rubocop/cop/sorbet/forbid_include_const_literal'
 require_relative 'rubocop/cop/sorbet/parameters_ordering_in_signature'
 require_relative 'rubocop/cop/sorbet/keyword_argument_ordering'
-require_relative 'rubocop/cop/sorbet/valid_sorbet_sigil'
+
+require_relative 'rubocop/cop/sorbet/sigils/valid_sigil'
+require_relative 'rubocop/cop/sorbet/sigils/has_sigil'
+require_relative 'rubocop/cop/sorbet/sigils/ignore_sigil'
+require_relative 'rubocop/cop/sorbet/sigils/false_sigil'
+require_relative 'rubocop/cop/sorbet/sigils/true_sigil'
+require_relative 'rubocop/cop/sorbet/sigils/strict_sigil'
+require_relative 'rubocop/cop/sorbet/sigils/strong_sigil'

data/rubocop-sorbet.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'rubocop-sorbet'
-  spec.version       = '0.3.2'
+  spec.version       = '0.3.3'
   spec.authors       = ['Ufuk Kayserilioglu', 'Alan Wu', 'Alexandre Terrasa', 'Peter Zhu']
   spec.email         = ['ruby@shopify.com']
 

data/service.yml

@@ -0,0 +1,6 @@
+# https://services.shopify.io/services/rubocop-sorbet/production
+owners:
+  - Shopify/sorbet
+classification: library
+slack_channels:
+  - sorbet

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-18 00:00:00.000000000 Z
+date: 2019-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -88,10 +88,17 @@ files:
 - lib/rubocop/cop/sorbet/forbid_superclass_const_literal.rb
 - lib/rubocop/cop/sorbet/keyword_argument_ordering.rb
 - lib/rubocop/cop/sorbet/parameters_ordering_in_signature.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
+- lib/rubocop/cop/sorbet/sigils/strict_sigil.rb
+- lib/rubocop/cop/sorbet/sigils/strong_sigil.rb
+- lib/rubocop/cop/sorbet/sigils/true_sigil.rb
+- lib/rubocop/cop/sorbet/sigils/valid_sigil.rb
 - lib/rubocop/cop/sorbet/signature_build_order.rb
-- lib/rubocop/cop/sorbet/valid_sorbet_sigil.rb
 - lib/rubocop_sorbet.rb
 - rubocop-sorbet.gemspec
+- service.yml
 - shipit.yml
 homepage: https://github.com/shopify/rubocop-sorbet
 licenses:

data/lib/rubocop/cop/sorbet/valid_sorbet_sigil.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module RuboCop
-  module Cop
-    module Sorbet
-      # This cop checks that every Ruby file contains a valid Sorbet sigil.
-      # Adapted from: https://gist.github.com/clarkdave/85aca4e16f33fd52aceb6a0a29936e52
-      #
-      # @example RequireSigilOnAllFiles: false (default)
-      #
-      #  # bad
-      #  # (start of file)
-      #  # typed: no
-      #
-      #  # good
-      #  # (start of file)
-      #  class Foo; end
-      #
-      #  # good
-      #  # (start of file)
-      #  # typed: true
-      #
-      # @example RequireSigilOnAllFiles: true
-      #
-      #  # bad
-      #  # (start of file)
-      #  class Foo; end
-      #
-      #  # bad
-      #  # (start of file)
-      #  # typed: no
-      #
-      #  # good
-      #  # (start of file)
-      #  # typed: true
-      class ValidSorbetSigil < RuboCop::Cop::Cop
-        def investigate(processed_source)
-          return if processed_source.tokens.empty?
-
-          sorbet_sigil_line = sorbet_typed_sigil_comment(processed_source)
-
-          if sorbet_sigil_line.nil?
-            token = processed_source.tokens.first
-
-            if require_sorbet_sigil_on_all_files?
-              add_offense(
-                token,
-                location: token.pos,
-                message: 'No Sorbet sigil found in file. ' \
-                  'Try a `typed: false` to start (you can also use `rubocop -a` to automatically add this).'
-              )
-            end
-          else
-            strictness = sorbet_typed_strictness(sorbet_sigil_line)
-            return if valid_sorbet_strictness?(strictness)
-
-            add_offense(
-              sorbet_sigil_line,
-              location: sorbet_sigil_line.pos,
-              message: "Invalid Sorbet sigil `#{strictness}`."
-            )
-          end
-        end
-
-        def autocorrect(_node)
-          lambda do |corrector|
-            return unless require_sorbet_sigil_on_all_files?
-            return unless sorbet_typed_sigil_comment(processed_source).nil?
-
-            token = processed_source.tokens.first
-
-            corrector.insert_before(token.pos, "# typed: false\n")
-          end
-        end
-
-        private
-
-        def require_sorbet_sigil_on_all_files?
-          !!cop_config['RequireSigilOnAllFiles']
-        end
-
-        SORBET_SIGIL_REGEX = /#\s+typed:\s+([\w]+)/
-
-        def sorbet_typed_sigil_comment(processed_source)
-          processed_source.tokens
-            .take_while { |token| token.type == :tCOMMENT }
-            .find { |token| SORBET_SIGIL_REGEX.match?(token.text) }
-        end
-
-        def valid_sorbet_strictness?(strictness)
-          %w(ignore false true strict strong).include?(strictness)
-        end
-
-        def sorbet_typed_strictness(sigil_line)
-          sigil_line.text.match(SORBET_SIGIL_REGEX)&.captures&.first
-        end
-      end
-    end
-  end
-end