rubocop-sorbet 0.0.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aceacd9544f68f9fa77c04eb851f4b9c950ae807bcd6acba40343930e1e09c60
-  data.tar.gz: 32568e235724593175627d5e27bf08fde7465bd0faaadf130f24928336ffa80c
+  metadata.gz: 7baa291ded0aa343c64c841b2d03cf91d52ad07071883a680f8b725297d0d8e9
+  data.tar.gz: 95e36584da91cccee6423d2d65fcc061ea74e1abfc51c4c5fb1a18f8b1878e62
 SHA512:
-  metadata.gz: 7c373c8ab61cb4801f0e15acc68d959d4b5dcc517a958083067b30461f3d6d1095b4c57ebf65e6e0c84ae5c50c2bfa3f8a5dc3c43809020315a5f02c1e82107f
-  data.tar.gz: fc0e8c2beaae55bd7d041c26c18d4bb33fe12531e024ac99ade345bd4854c7196a3717af0f605408f4f9b50ab6dd77db368862c946547063b853980f4de5831b
+  metadata.gz: 2d3772bb095eed330fbab2f2ff723f932bc4b40a175738532e043c6fbb66c9c2116a9435b4b210cf2b0f59dc3b8be889da976293db38f6e42f583be9dd8ddb26
+  data.tar.gz: 04a54d3d285223f71d48f4a164ec69124ce9b45d74eba3c7232abd6388e9638acb3e8fada94f2f88533432e51077d03952037d1828850261e623797dacd7b9a5

data/.github/probots.yml

@@ -0,0 +1,3 @@
+enabled:
+  - cla
+

data/CODE_OF_CONDUCT.md

@@ -3,11 +3,11 @@
 ## Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
+contributors and maintainers pledge to make participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
@@ -23,7 +23,7 @@ include:
 Examples of unacceptable behavior by participants include:
 
 * The use of sexualized language or imagery and unwelcome sexual attention or
-advances
+  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
@@ -45,17 +45,17 @@ threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at ufuk@paralaus.com. All
+reported by contacting the project team at opensource@shopify.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -68,7 +68,10 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile.lock

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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Ufuk Kayserilioglu
+Copyright (c) 2019-present, Shopify Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,7 @@
 # Rubocop-Sorbet
 
+[![Build Status](https://travis-ci.org/Shopify/rubocop-sorbet.svg?branch=master)](https://travis-ci.org/Shopify/rubocop-sorbet)
+
 A collection of Rubocop rules for Sorbet.
 
 ## Installation
@@ -29,7 +31,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Shopif
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://github.com/Shopify/rubocop-sorbet/blob/master/LICENSE.txt).
 
 ## Code of Conduct
 

data/config/default.yml

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

data/dev.yml

@@ -6,5 +6,6 @@ up:
   - ruby: "2.5.5"
   - "bundler"
 
-test:
-  run: "bin/rspec"
+commands:
+  test:   "bin/rspec"
+  style:  "bundle exec rubocop"

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

@@ -43,7 +43,7 @@ module RuboCop
           add_offense(
             node,
             location: :selector,
-            message: "Don't use `#{node.method_name}`, it make the code harder to understand, less editor-friendly " \
+            message: "Don't use `#{node.method_name}`, it makes the code harder to understand, less editor-friendly, " \
               "and impossible to analyze. Replace `#{node.method_name}` with a case/when or a hash."
           )
         end

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

@@ -24,6 +24,7 @@ module RuboCop
             :overridable,
             :soft,
             :checked,
+            :on_failure,
           ].each_with_index.to_h.freeze
 
         def_node_matcher(:signature?, <<~PATTERN)

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

@@ -0,0 +1,102 @@
+# 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

data/lib/rubocop_sorbet.rb

@@ -9,3 +9,4 @@ 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'

data/rubocop-sorbet.gemspec

@@ -5,9 +5,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'rubocop-sorbet'
-  spec.version       = '0.0.2'
-  spec.authors       = ['Ufuk Kayserilioglu']
-  spec.email         = ['ufuk.kayserilioglu@shopify.com']
+  spec.version       = '0.3.2'
+  spec.authors       = ['Ufuk Kayserilioglu', 'Alan Wu', 'Alexandre Terrasa', 'Peter Zhu']
+  spec.email         = ['ruby@shopify.com']
 
   spec.summary       = 'Automatic Sorbet code style checking tool.'
   spec.homepage      = 'https://github.com/shopify/rubocop-sorbet'

metadata

@@ -1,14 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.3.2
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
+- Alan Wu
+- Alexandre Terrasa
+- Peter Zhu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2019-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -54,11 +57,12 @@ dependencies:
         version: '0.57'
 description: 
 email:
-- ufuk.kayserilioglu@shopify.com
+- ruby@shopify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/probots.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".shopify-build/VERSION"
@@ -73,6 +77,7 @@ files:
 - bin/console
 - bin/rspec
 - bin/setup
+- config/default.yml
 - dev.yml
 - lib/rubocop-sorbet.rb
 - lib/rubocop/cop/sorbet/allow_incompatible_override.rb
@@ -84,6 +89,7 @@ files:
 - lib/rubocop/cop/sorbet/keyword_argument_ordering.rb
 - lib/rubocop/cop/sorbet/parameters_ordering_in_signature.rb
 - lib/rubocop/cop/sorbet/signature_build_order.rb
+- lib/rubocop/cop/sorbet/valid_sorbet_sigil.rb
 - lib/rubocop_sorbet.rb
 - rubocop-sorbet.gemspec
 - shipit.yml
@@ -108,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.