Aw js/add rubocop (#14)

* Add another supported platform

Co-authored-by: Joey Schoblaska <[email protected]>

* Add rubocop to code teams

Co-authored-by: Joey Schoblaska <[email protected]>

* re-add require "set"

* add type arguments for generic class

Co-authored-by: Perry Hertler <[email protected]>
Co-authored-by: Ashley Willard <[email protected]>

---------

Co-authored-by: Joey Schoblaska <[email protected]>
Co-authored-by: Perry Hertler <[email protected]>

Author: 3 people

.rubocop.yml

@@ -0,0 +1,123 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+AllCops:
+  NewCops: enable
+  Exclude:
+    - vendor/bundle/**/**
+  TargetRubyVersion: 2.6
+
+Metrics/ParameterLists:
+  Enabled: false
+
+# This cop is annoying with typed configuration
+Style/TrivialAccessors:
+  Enabled: false
+
+# This rubocop is annoying when we use interfaces a lot
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Lint/DuplicateBranch:
+  Enabled: false
+
+# If is sometimes easier to think about than unless sometimes
+Style/NegatedIf:
+  Enabled: false
+
+# Disabling for now until it's clearer why we want this
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# It's nice to be able to read the condition first before reading the code within the condition
+Style/GuardClause:
+  Enabled: false
+
+#
+# Leaving length metrics to human judgment for now
+#
+Metrics/ModuleLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+# This doesn't feel useful
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+# This doesn't feel useful
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# It's nice to be able to read the condition first before reading the code within the condition
+Style/IfUnlessModifier:
+  Enabled: false
+
+# This leads to code that is not very readable at times (very long lines)
+Style/ConditionalAssignment:
+  Enabled: false
+
+# For now, we prefer to lean on clean method signatures as documentation. We may change this later.
+Style/Documentation:
+  Enabled: false
+
+# Sometimes we leave comments in empty else statements intentionally
+Style/EmptyElse:
+  Enabled: false
+
+# Sometimes we want to more explicitly list out a condition
+Style/RedundantCondition:
+  Enabled: false
+
+# This leads to code that is not very readable at times (very long lines)
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+# Blocks across lines are okay sometimes
+Style/BlockDelimiters:
+  Enabled: false
+
+# Sometimes we like methods like `get_packages`
+Naming/AccessorMethodName:
+  Enabled: false
+
+# This leads to code that is not very readable at times (very long lines)
+Layout/FirstArgumentIndentation:
+  Enabled: false
+
+# This leads to code that is not very readable at times (very long lines)
+Layout/ArgumentAlignment:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: true
+  EnforcedStyle: gemspec

Gemfile.lock

@@ -7,13 +7,24 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     coderay (1.1.3)
     diff-lcs (1.4.4)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    racc (1.7.3)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -27,16 +38,32 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    sorbet (0.5.9889)
-      sorbet-static (= 0.5.9889)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    sorbet (0.5.11122)
+      sorbet-static (= 0.5.11122)
     sorbet-runtime (0.5.9976)
-    sorbet-static (0.5.9889-universal-darwin-20)
-    sorbet-static (0.5.9889-universal-darwin-21)
-    sorbet-static (0.5.9889-x86_64-linux)
+    sorbet-static (0.5.11122-universal-darwin)
+    sorbet-static (0.5.11122-x86_64-linux)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   arm64-darwin-20
   arm64-darwin-21
+  arm64-darwin-22
+  arm64-darwin-23
   x86_64-darwin-20
   x86_64-linux
 
@@ -45,6 +72,7 @@ DEPENDENCIES
   pry
   rake
   rspec (~> 3.0)
+  rubocop
   sorbet
 
 BUNDLED WITH

code_teams.gemspec

@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'sorbet'
 end

lib/code_teams.rb

@@ -116,16 +116,16 @@ def to_tag
     sig { params(other: Object).returns(T::Boolean) }
     def ==(other)
       if other.is_a?(CodeTeams::Team)
-        self.name == other.name
+        name == other.name
       else
         false
       end
     end
 
-    alias_method :eql?, :==
+    alias eql? ==
 
     sig { returns(Integer) }
-    def hash # rubocop:disable Rails/Delegate
+    def hash
       name.hash
     end
   end

lib/code_teams/plugin.rb

@@ -28,7 +28,7 @@ def self.all_plugins
     end
 
     sig { params(teams: T::Array[Team]).returns(T::Array[String]) }
-    def self.validation_errors(teams) # rubocop:disable Lint/UnusedMethodArgument
+    def self.validation_errors(teams)
       []
     end
 
@@ -42,9 +42,9 @@ def self.missing_key_error_message(team, key)
       "#{team.name} is missing required key `#{key}`"
     end
 
-    sig { returns(T::Hash[T.nilable(String), T::Hash[Class, Plugin]]) }
+    sig { returns(T::Hash[T.nilable(String), T::Hash[T.class_of(Plugin), Plugin]]) }
     def self.registry
-      @registry ||= T.let(@registry, T.nilable(T::Hash[String, T::Hash[Class, Plugin]]))
+      @registry ||= T.let(@registry, T.nilable(T::Hash[String, T::Hash[T.class_of(Plugin), Plugin]]))
       @registry ||= {}
       @registry
     end

spec/lib/code_teams_spec.rb

@@ -54,7 +54,7 @@
       it 'registers the team file as invalid' do
         expect(validation_errors).to match_array(
           [
-            'More than 1 definition for My Team found',
+            'More than 1 definition for My Team found'
           ]
         )
       end
@@ -64,7 +64,7 @@
   describe '==' do
     it 'handles nil correctly' do
       expect(CodeTeams.all.first == nil).to eq false # rubocop:disable Style/NilComparison
-      expect(nil == CodeTeams.all.first).to eq false
+      expect(CodeTeams.all.first.nil?).to eq false
     end
   end
 end