Enable all cops, but opt all files out of rubocop (#2708)

* Enable all cops, but opt all files out of rubocop

* only install rubocop on ruby >= 2.6

* ignore rubocop for jrubies as well

* solargraph 0.49 depends on rbs, which won't build for jruby for some reason

* restrict solargraph to mri

* fix typo

Author: jamis

.rubocop.yml

@@ -1,29 +1,49 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 2.5
-  NewCops: disable
-  Include:
-    - 'lib/**/*'
+  NewCops: enable
+  Exclude:
+    - 'spec/shared/**/*'
+    - 'vendor/**/*'
 
 Bundler:
-  Enabled: false
+  Enabled: true
 
 Gemspec:
-  Enabled: false
+  Enabled: true
 
 Layout:
-  Enabled: false
+  Enabled: true
 
 Lint:
-  Enabled: false
+  Enabled: true
 
 Metrics:
-  Enabled: false
+  Enabled: true
 
 Naming:
-  Enabled: false
+  Enabled: true
 
 Security:
   Enabled: true
 
 Style:
+  Enabled: true
+
+# --------------------------------------
+# Cops below this line set intentionally
+# --------------------------------------
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Gemspec/OrderedDependencies:
   Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'

Gemfile

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
 source 'https://rubygems.org'
 
 gemspec

Rakefile

@@ -1,4 +1,5 @@
-# -*- mode: ruby -*-
+# frozen_string_literal: true
+# rubocop:todo all
 
 require 'bundler'
 require 'bundler/gem_tasks'

bin/mongo_console

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+# rubocop:todo all
 
 $LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
 

examples/aggregate.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Group documents by field and calculate count.
 

examples/create.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Insert a document
 

examples/delete.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Delete all documents matching a condition
 

examples/index.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Create a single field index
 

examples/query.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Query for all documents in a collection
 

examples/update.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Update top-level fields in a single document
 

gemfiles/bson_4-stable.gemfile

@@ -1,3 +1,4 @@
+# rubocop:todo all
 source "https://rubygems.org"
 gemspec path: '..'
 

gemfiles/bson_master.gemfile

@@ -1,3 +1,4 @@
+# rubocop:todo all
 source "https://rubygems.org"
 gemspec path: '..'
 

gemfiles/bson_min.gemfile

@@ -1,3 +1,4 @@
+# rubocop:todo all
 source "https://rubygems.org"
 gemspec path: '..'
 

gemfiles/mongo_kerberos.gemfile

@@ -1,3 +1,4 @@
+# rubocop:todo all
 source "https://rubygems.org"
 gemspec path: '..'
 

gemfiles/snappy_compression.gemfile

@@ -1,3 +1,4 @@
+# rubocop:todo all
 source "https://rubygems.org"
 gemspec path: '..'
 

gemfiles/standard.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 def standard_dependencies
   gem 'yard'
@@ -29,8 +29,14 @@ def standard_dependencies
     gem 'yajl-ruby', platforms: :mri, require: false
     gem 'celluloid', platforms: :mri, require: false
 
-    # for static analysis
-    gem 'rubocop', '~> 1.27.0'
+    # for static analysis -- ignore ruby < 2.6 because of rubocop
+    # version incompatibilities
+    if RUBY_VERSION > "2.5.99"
+      gem 'rubocop', '~> 1.45.1'
+      gem 'rubocop-performance', '~> 1.16.0'
+      gem 'rubocop-rake', '~> 0.6.0'
+      gem 'rubocop-rspec', '~> 2.18.1'
+    end
 
     platform :mri do
       # Debugger for VSCode.
@@ -60,7 +66,8 @@ def standard_dependencies
     gem 'ruby-prof', platforms: :mri
     gem 'erubi'
     gem 'tilt'
-    gem 'solargraph'
+    # solargraph depends on rbs, which won't build on jruby for some reason
+    gem 'solargraph', platforms: :mri
   end
 
   if ENV['FLE'] == 'helper'

gemfiles/zstd_compression.gemfile

@@ -1,3 +1,4 @@
+# rubocop:todo all
 source "https://rubygems.org"
 gemspec path: '..'
 

lib/mongo.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/active_support.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

lib/mongo/address.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/address/ipv4.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/address/ipv6.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/address/unix.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/address/validator.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #

lib/mongo/auth.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/auth/aws.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

lib/mongo/auth/aws/conversation.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

lib/mongo/auth/aws/credentials.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 # Copyright (C) 2023-present MongoDB Inc.
 #

lib/mongo/auth/aws/credentials_cache.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 # Copyright (C) 2023-present MongoDB Inc.
 #

lib/mongo/auth/aws/credentials_retriever.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

lib/mongo/auth/aws/request.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

lib/mongo/auth/base.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/auth/conversation_base.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

lib/mongo/auth/cr.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/auth/cr/conversation.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/auth/credential_cache.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

lib/mongo/auth/gssapi.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB, Inc.
 #

lib/mongo/auth/gssapi/conversation.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

lib/mongo/auth/ldap.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/auth/ldap/conversation.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/auth/roles.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/auth/sasl_conversation_base.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

lib/mongo/auth/scram.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/auth/scram/conversation.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

lib/mongo/auth/scram256.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

lib/mongo/auth/scram256/conversation.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

lib/mongo/auth/scram_conversation_base.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #