rubocop-sorbet 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ad80ed7bb1d6485194f669d289efba935cecb7adff45f542ba8ada36171a57f
-  data.tar.gz: f2129cc057c628df84b40e4ba24d376624fa6ad3e3b7a27025a53e0f5862c422
+  metadata.gz: 6740f039852d221e50f5f80f77f899a35135dfc91f19ded44e3cc909e9ba85f4
+  data.tar.gz: 518ecd83900a4e20548bd22b659b9853ed5742429195344ec224e29e7d127986
 SHA512:
-  metadata.gz: 4c493e9d0aa2718629cfba7c84a8c7ec530bb5b942c273d10b8893594ef7f2cb219227e7499a0981f400d7b10f0cef986adba8c0ad480c90d84ff8c14e5ceda1
-  data.tar.gz: 5b8d8d04a8b6a77feeb11929d6a4a55804dac5f7eeccf2ed47f0b7ed0dac1b30f08cefa030d59ea623e9fe907a01f0e48ab933f6476d86bf729b0597dcc7130c
+  metadata.gz: 2b73e591e2137443e2485c596295446270a86685dc1d185ba5e2f98615b9618ed9b5c0b979d563ae18611fb9184023803de62a01db810d6ed2a0fd6475eaa840
+  data.tar.gz: eb57d0b9971e242fb9fb42e238487339e70c463c54a121dd1b4d1c7599459ffae0cdf1628801c1c280fed5f379a13fd2699329e1833c21a98423a6f94ad4e357

data/Gemfile.lock

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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Ufuk Kayserilioglu
+Copyright (c) 2019 Shopify
 
 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/lib/rubocop/cop/sorbet/valid_sorbet_sigil.rb

@@ -0,0 +1,81 @@
+# 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
+      #
+      #  # 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
+
+            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).'
+            )
+          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 sorbet_typed_sigil_comment(processed_source).nil?
+
+            token = processed_source.tokens.first
+
+            corrector.insert_before(token.pos, "# typed: false\n")
+          end
+        end
+
+        private
+
+        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.2.0'
-  spec.authors       = ['Ufuk Kayserilioglu']
-  spec.email         = ['ufuk.kayserilioglu@shopify.com']
+  spec.version       = '0.3.0'
+  spec.authors       = ['Ufuk Kayserilioglu', 'Alan Wu', 'Alexandre Terrasa', 'Peter Zhu']
+  spec.email         = ['rails@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.2.0
+  version: 0.3.0
 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-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -54,7 +57,7 @@ dependencies:
         version: '0.57'
 description: 
 email:
-- ufuk.kayserilioglu@shopify.com
+- rails@shopify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -64,7 +67,6 @@ files:
 - ".shopify-build/VERSION"
 - ".shopify-build/rubocop-sorbet.yml"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -84,6 +86,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

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## 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
-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.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-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.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at ufuk@paralaus.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.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-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]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/