Update rubocop to version 1.35.1 (#148)

* Update rubocop to version 1.35.1

* Fix renamed and moved rubocop style definitions

* Ignore auto-generated gemfiles for rubocop

* Fix changed rubocop department names

* Update targeted Ruby version to 2.7

* Configure rubocop to automatically enable new cops as they come

* Generate rubocop todo

* Fix Gemspec/OrderedDependencies

* Define that gem must be published with MFA

* Explicitly disable Gemspec/RequiredRubyVersion cop

* Fix Layout/EmptyLineAfterMagicComment

* Fix Layout/EmptyLineAfterGuardClause

* Remove most rubocop custom configurations

* Disable all Metrics department cops

* Disable Style/StringLiterals

* Autofix Style/SymbolArray

* Autofix Style/StructInheritance

* Autofix Style/StringConcatenation

* Autofix Layout/SpaceInsideHashLiteralBraces

* Autofix Style/AccessorGrouping

* Autofix Style/BlockDelimiters

* Autofix Style/ExpandPathArguments

* Autofix Style/RedundantFreeze

* Autofix Style/IfUnlessModifier

* Autofix Style/SignalException

* Autofix Style/Encoding

* Manually fix Lint/EmptyBlock

* Manually fix Naming/HeredocDelimiterNaming

* Autofix Style/CollectionCompact

* Autofix Lint/NonDeterministicRequireOrder

* Stop suggesting rubocop-rake and rubocop-rspec gems

* Disable Style/Documentation

* Autofix Style/FrozenStringLiteralComment

* Manually fix Style/GuardClause

* Manually fix Naming/MethodParameterName

Author: valscion

.rubocop.yml

@@ -1,113 +1,46 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  SuggestExtensions: false
   Exclude:
     - 'bin/*'
+    - 'gemfiles/*'
     - 'spec/dummy/db/schema.rb'
     - 'vendor/bundle/**/*'
     - 'tmp/**/*'
 
-Style/FileName:
+# TODO: Define a spec.required_ruby_version when shipping a new version
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Naming/FileName:
   Exclude:
     - lib/jsonapi-authorization.rb
     - Appraisals
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: true
   Max: 100
   Exclude:
     - spec/requests/**/*.rb
     - jsonapi-authorization.gemspec
 
-Style/MultilineOperationIndentation:
+Layout/MultilineOperationIndentation:
   EnforcedStyle: indented
 
-Style/MultilineMethodCallIndentation:
+Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
-Metrics/ClassLength:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/ExtraSpacing:
-  AllowForAlignment: true
-
-Metrics/MethodLength:
-  Enabled: false
-
-Style/Next:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Style/DoubleNegation:
-  Enabled: false
-
-Style/SignalException:
+# We don't want rubocop to enforce splitting methods and stuff like that.
+Metrics:
   Enabled: false
 
+# We don't care what kind of quotes you use
 Style/StringLiterals:
   Enabled: false
 
-Style/SpaceInsideHashLiteralBraces:
-  Enabled: false
-  EnforcedStyle: space
-
-Style/IndentHash:
-  EnforcedStyle: consistent
-
-Style/IndentArray:
-  EnforcedStyle: consistent
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/BlockDelimiters:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false
-
-Style/ClosingParenthesisIndentation:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/NumericLiterals:
-  Enabled: false
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/StructInheritance:
-  Enabled: false
-
-Style/MultilineBlockChain:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
-
-Style/WordArray:
-  MinSize: 2
-
-Metrics/ModuleLength:
+# It's up to us how much we want to document the code
+Style/Documentation:
   Enabled: false
-
-Style/SingleLineBlockParams:
-  Methods:
-    - reduce:
-        - acc
-        - obj
-    - inject:
-        - acc
-        - obj
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method

.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-08-24 19:47:54 UTC using RuboCop version 1.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'rails-5-2 pundit-1' do
   gem 'rails', '5.2.4.4'
   gem 'jsonapi-resources', '~> 0.9.0'

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

jsonapi-authorization.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jsonapi/authorization/version'
 
@@ -22,14 +23,15 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler", ">= 1.11"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.11"
-  spec.add_development_dependency "rspec-rails", "~> 5.1"
+  spec.add_development_dependency "phare", "~> 1.0.1"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "pry-doc"
   spec.add_development_dependency "pry-rails"
-  spec.add_development_dependency "rubocop", "~> 0.36.0"
-  spec.add_development_dependency "phare", "~> 1.0.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_development_dependency "rspec-rails", "~> 5.1"
+  spec.add_development_dependency "rubocop", "~> 1.35.1"
   spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

lib/jsonapi-authorization.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'jsonapi/authorization'

lib/jsonapi/authorization.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jsonapi-resources"
 require "jsonapi/authorization/authorizing_processor"
 require "jsonapi/authorization/configuration"

lib/jsonapi/authorization/authorizing_processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pundit'
 
 module JSONAPI
@@ -22,19 +24,20 @@ class AuthorizingProcessor < JSONAPI::Processor
         :authorize_replace_polymorphic_to_one_relationship
       )
 
-      [
-        :find,
-        :show,
-        :show_related_resource,
-        :show_related_resources,
-        :create_resource,
-        :replace_fields
+      %i[
+        find
+        show
+        show_related_resource
+        show_related_resources
+        create_resource
+        replace_fields
       ].each do |op_name|
         set_callback op_name, :after, :authorize_include_directive
       end
 
       def authorize_include_directive
         return if result.is_a?(::JSONAPI::ErrorsOperationResult)
+
         resources = Array.wrap(
           if result.respond_to?(:resources)
             result.resources
@@ -220,7 +223,7 @@ def authorize_remove_to_many_relationships
         related_records = related_resources.map(&:_model)
 
         if related_records.size != params[:associated_keys].uniq.size
-          fail JSONAPI::Exceptions::RecordNotFound, params[:associated_keys]
+          raise JSONAPI::Exceptions::RecordNotFound, params[:associated_keys]
         end
 
         authorizer.remove_to_many_relationship(
@@ -306,7 +309,7 @@ def related_models_with_context
         data = params[:data]
         return { relationship: nil, relation_name: nil, records: nil } if data.nil?
 
-        [:to_one, :to_many].flat_map do |rel_type|
+        %i[to_one to_many].flat_map do |rel_type|
           data[rel_type].flat_map do |assoc_name, assoc_value|
             related_models =
               case assoc_value
@@ -321,7 +324,7 @@ def related_models_with_context
                 resources.map(&:_model).tap do |scoped_records|
                   related_ids = Array.wrap(assoc_value).uniq
                   if scoped_records.count != related_ids.count
-                    fail JSONAPI::Exceptions::RecordNotFound, related_ids
+                    raise JSONAPI::Exceptions::RecordNotFound, related_ids
                   end
                 end
               else
@@ -339,10 +342,10 @@ def related_models_with_context
       end
 
       def authorize_model_includes(source_record)
-        if params[:include_directives]
-          params[:include_directives].model_includes.each do |include_item|
-            authorize_include_item(@resource_klass, source_record, include_item)
-          end
+        return unless params[:include_directives]
+
+        params[:include_directives].model_includes.each do |include_item|
+          authorize_include_item(@resource_klass, source_record, include_item)
         end
       end
 
@@ -376,6 +379,7 @@ def authorize_include_item(resource_klass, source_record, include_item)
               relationship.relation_name(context: context)
             )
             return if related_record.nil?
+
             authorizer.include_has_one_resource(
               source_record: source_record, related_record: related_record
             )

lib/jsonapi/authorization/configuration.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'jsonapi/authorization/default_pundit_authorizer'
 
 module JSONAPI
   module Authorization
     class Configuration
-      attr_accessor :authorizer
-      attr_accessor :pundit_user
+      attr_accessor :authorizer, :pundit_user
 
       def initialize
         self.authorizer  = ::JSONAPI::Authorization::DefaultPunditAuthorizer