Rubocop linting

Author: pboling

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-03-21 02:34:29 UTC using RuboCop version 1.11.0.
+# on 2021-03-24 02:03:11 UTC using RuboCop version 1.11.0.
 # 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
@@ -13,12 +13,13 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'omniauth-identity.gemspec'
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
 Lint/ConstantDefinitionInBlock:
   Exclude:
-    - 'spec/omniauth/identity/models/active_record_spec.rb'
+    - 'spec_orms/active_record_spec.rb'
+    - 'spec_orms/sequel_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: AllowComments.
@@ -27,11 +28,18 @@ Lint/EmptyClass:
     - 'spec/omniauth/identity/secure_password_spec.rb'
 
 # Offense count: 1
-Lint/NestedMethodDefinition:
+Lint/MissingSuper:
   Exclude:
     - 'lib/omniauth/identity/secure_password.rb'
 
 # Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+    - 'Rakefile'
+
+# Offense count: 2
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 30
@@ -40,14 +48,14 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 28
+  Max: 32
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
   Max: 145
 
-# Offense count: 7
+# Offense count: 9
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 20
@@ -82,19 +90,29 @@ Naming/PredicateName:
     - 'spec/**/*'
     - 'lib/omniauth/identity/secure_password.rb'
 
-# Offense count: 7
+# Offense count: 3
+RSpec/BeforeAfterAll:
+  Exclude:
+    - 'spec/spec_helper.rb'
+    - 'spec/rails_helper.rb'
+    - 'spec/support/**/*.rb'
+    - 'spec_orms/couch_potato_spec.rb'
+    - 'spec_orms/nobrainer_spec.rb'
+    - 'spec_orms/sequel_spec.rb'
+
+# Offense count: 6
 # Configuration parameters: Prefixes.
 # Prefixes: when, with, without
 RSpec/ContextWording:
   Exclude:
-    - 'spec/omniauth/identity/model_spec.rb'
     - 'spec/omniauth/strategies/identity_spec.rb'
+    - 'spec/support/shared_contexts/persistable_model.rb'
 
 # Offense count: 1
 # Configuration parameters: Max.
 RSpec/ExampleLength:
   Exclude:
-    - 'spec/omniauth/identity/model_spec.rb'
+    - 'spec/support/shared_contexts/instance_with_instance_methods.rb'
 
 # Offense count: 3
 RSpec/ExpectInHook:
@@ -107,18 +125,19 @@ RSpec/ExpectInHook:
 RSpec/FilePath:
   Exclude:
     - 'spec/omniauth/identity/model_spec.rb'
-    - 'spec/omniauth/identity/models/active_record_spec.rb'
-    - 'spec/omniauth/identity/models/couch_potato_spec.rb'
-    - 'spec/omniauth/identity/models/mongoid_spec.rb'
-    - 'spec/omniauth/identity/models/nobrainer_spec.rb'
-    - 'spec/omniauth/identity/models/sequel_spec.rb'
     - 'spec/omniauth/identity/secure_password_spec.rb'
     - 'spec/omniauth/strategies/identity_spec.rb'
+    - 'spec_orms/active_record_spec.rb'
+    - 'spec_orms/couch_potato_spec.rb'
+    - 'spec_orms/mongoid_spec.rb'
+    - 'spec_orms/nobrainer_spec.rb'
+    - 'spec_orms/sequel_spec.rb'
 
-# Offense count: 1
+# Offense count: 2
 RSpec/LeakyConstantDeclaration:
   Exclude:
-    - 'spec/omniauth/identity/models/active_record_spec.rb'
+    - 'spec_orms/active_record_spec.rb'
+    - 'spec_orms/sequel_spec.rb'
 
 # Offense count: 8
 # Configuration parameters: .
@@ -135,13 +154,11 @@ RSpec/MultipleExpectations:
 RSpec/MultipleMemoizedHelpers:
   Max: 8
 
-# Offense count: 44
+# Offense count: 1
 # Configuration parameters: IgnoreSharedExamples.
 RSpec/NamedSubject:
   Exclude:
-    - 'spec/omniauth/identity/model_spec.rb'
-    - 'spec/omniauth/identity/models/couch_potato_spec.rb'
-    - 'spec/omniauth/identity/models/mongoid_spec.rb'
+    - 'spec_orms/mongoid_spec.rb'
 
 # Offense count: 12
 RSpec/NestedGroups:
@@ -152,27 +169,28 @@ RSpec/StubbedMock:
   Exclude:
     - 'spec/omniauth/strategies/identity_spec.rb'
 
-# Offense count: 22
+# Offense count: 5
 RSpec/SubjectStub:
   Exclude:
-    - 'spec/omniauth/identity/model_spec.rb'
-    - 'spec/omniauth/identity/models/active_record_spec.rb'
-    - 'spec/omniauth/identity/models/couch_potato_spec.rb'
-    - 'spec/omniauth/identity/models/mongoid_spec.rb'
+    - 'spec_orms/active_record_spec.rb'
+    - 'spec_orms/couch_potato_spec.rb'
+    - 'spec_orms/mongoid_spec.rb'
+    - 'spec_orms/nobrainer_spec.rb'
+    - 'spec_orms/sequel_spec.rb'
 
 # Offense count: 4
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Exclude:
-    - 'spec/omniauth/identity/model_spec.rb'
     - 'spec/omniauth/strategies/identity_spec.rb'
+    - 'spec/support/shared_contexts/model_with_class_methods.rb'
 
 # Offense count: 1
 Rake/Desc:
   Exclude:
     - 'Rakefile'
 
-# Offense count: 7
+# Offense count: 10
 Style/Documentation:
   Exclude:
     - '**/*.md'
@@ -184,24 +202,30 @@ Style/Documentation:
     - 'lib/omniauth/identity/secure_password.rb'
     - 'spec/omniauth/identity/secure_password_spec.rb'
 
-# Offense count: 5
+# Offense count: 4
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
     - 'lib/omniauth/identity/model.rb'
     - 'lib/omniauth/identity/secure_password.rb'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/omniauth/strategies/identity.rb'
+
 # Offense count: 1
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: respond_to_missing?
 Style/OptionalBooleanParameter:
   Exclude:
     - 'lib/omniauth/identity/model.rb'
 
-# Offense count: 1
+# Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 # IgnoredPatterns: (?-mix:^\#)
 Layout/LineLength:
-  Max: 123
+  Max: 138

Gemfile

@@ -24,11 +24,11 @@ group :development, :test do
     gem 'activerecord', '~> 6', require: false # rails 6 requires Ruby 2.5 or later
   end
   gem 'anonymous_active_record', '~> 1', require: false
+  gem 'couch_potato', github: 'langalex/couch_potato', require: false
   gem 'mongoid', '~> 7', require: false
+  gem 'mongoid-rspec', github: 'mongoid/mongoid-rspec', require: false
   gem 'nobrainer', '~> 0', require: false
   gem 'sequel', '~> 5', require: false
-  gem 'couch_potato', github: 'langalex/couch_potato', require: false
-  gem 'mongoid-rspec', github: 'mongoid/mongoid-rspec', require: false
 
   if ruby_version >= Gem::Version.new('2.4')
     # No need to run byebug / pry on earlier versions

README.md

@@ -294,16 +294,16 @@ Please contribute some documentation if you have the gumption!  The maintainer's
    ```bash
    # CouchDB / CouchPotato
    bundle exec rspec spec spec_orms --tag 'couchdb'
-   
+
    # ActiveRecord and Sequel, as they both use the in-memory SQLite driver.
    bundle exec rspec spec spec_orms --tag 'sqlite3'
 
    # NOTE - mongoid and nobrainer specs can't be isolated with "tag" because it still loads everything,
    #        and the two libraries are fundamentally incompatible.
-  
+
    # MongoDB / Mongoid
    bundle exec rspec spec_orms/mongoid_spec.rb
-   
+
    # RethinkDB / NoBrainer
    bundle exec rspec spec_orms/nobrainer_spec.rb
    ```

Rakefile

@@ -6,15 +6,15 @@ begin
   require 'rspec/core/rake_task'
   primary = RSpec::Core::RakeTask.new(:spec)
   active_record = RSpec::Core::RakeTask.new(:spec_orm_active_record)
-  active_record.pattern = "spec_orms/active_record_spec.rb"
+  active_record.pattern = 'spec_orms/active_record_spec.rb'
   couch_potato = RSpec::Core::RakeTask.new(:spec_orm_couch_potato)
-  couch_potato.pattern = "spec_orms/couch_potato_spec.rb"
+  couch_potato.pattern = 'spec_orms/couch_potato_spec.rb'
   mongoid = RSpec::Core::RakeTask.new(:spec_orm_mongoid)
-  mongoid.pattern = "spec_orms/mongoid_spec.rb"
+  mongoid.pattern = 'spec_orms/mongoid_spec.rb'
   nobrainer = RSpec::Core::RakeTask.new(:spec_orm_nobrainer)
-  nobrainer.pattern = "spec_orms/nobrainer_spec.rb"
+  nobrainer.pattern = 'spec_orms/nobrainer_spec.rb'
   sequel = RSpec::Core::RakeTask.new(:spec_orm_sequel)
-  sequel.pattern = "spec_orms/sequel_spec.rb"
+  sequel.pattern = 'spec_orms/sequel_spec.rb'
 rescue LoadError
   task :spec do
     warn 'RSpec is disabled'
@@ -31,11 +31,11 @@ rescue LoadError
   end
 end
 
-task default: [
-  :test,
-  :spec_orm_active_record,
-  :spec_orm_couch_potato,
-  :spec_orm_mongoid,
-  :spec_orm_nobrainer,
-  :spec_orm_sequel
+task default: %i[
+  test
+  spec_orm_active_record
+  spec_orm_couch_potato
+  spec_orm_mongoid
+  spec_orm_nobrainer
+  spec_orm_sequel
 ]

lib/omniauth/identity/model.rb

@@ -54,7 +54,6 @@ def auth_key(method = false)
           @auth_key || 'email'
         end
 
-
         # Locate an identity given its unique login key.
         #
         # @abstract

lib/omniauth/identity/secure_password.rb

@@ -73,9 +73,9 @@ def has_secure_password(attribute = :password, validations: true)
           # This is to avoid ActiveModel (and by extension the entire framework)
           # being dependent on a binary library.
           begin
-            require "bcrypt"
+            require 'bcrypt'
           rescue LoadError
-            $stderr.puts "You don't have bcrypt installed in your application. Please add it to your Gemfile and run bundle install"
+            warn "You don't have bcrypt installed in your application. Please add it to your Gemfile and run bundle install"
             raise
           end
 
@@ -104,11 +104,11 @@ def initialize(attribute)
 
           define_method("#{attribute}=") do |unencrypted_password|
             if unencrypted_password.nil?
-              self.public_send("#{attribute}_digest=", nil)
+              public_send("#{attribute}_digest=", nil)
             elsif !unencrypted_password.empty?
               instance_variable_set("@#{attribute}", unencrypted_password)
               cost = ActiveModel::SecurePassword.min_cost ? BCrypt::Engine::MIN_COST : BCrypt::Engine.cost
-              self.public_send("#{attribute}_digest=", BCrypt::Password.create(unencrypted_password, cost: cost))
+              public_send("#{attribute}_digest=", BCrypt::Password.create(unencrypted_password, cost: cost))
             end
           end
 

omniauth-identity.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'bcrypt'
   gem.add_runtime_dependency 'omniauth'
 
-  gem.add_development_dependency 'rspec-block_is_expected', '~> 1.0'
   gem.add_development_dependency 'rack-test', '~> 1'
   gem.add_development_dependency 'rake', '~> 13'
   gem.add_development_dependency 'rspec', '~> 3'
+  gem.add_development_dependency 'rspec-block_is_expected', '~> 1.0'
   gem.add_development_dependency 'sqlite3', '~> 1.4'
   # NOTE: Released version of couch_potato depends on activemodel ~> 4.0, so pull latest from github in Gemfile.
   # gem.add_development_dependency 'couch_potato', '~> 1.7'

spec/spec_helper.rb

@@ -18,7 +18,7 @@
 require 'omniauth/identity'
 
 spec_root_matcher = %r{#{__dir__}/(.+)\.rb\Z}
-Dir.glob(Pathname.new(__dir__).join("support/**/", "*.rb")).each { |f| require f.match(spec_root_matcher)[1] }
+Dir.glob(Pathname.new(__dir__).join('support/**/', '*.rb')).each { |f| require f.match(spec_root_matcher)[1] }
 
 DEFAULT_PASSWORD = 'hang-a-left-at-the-diner'
 DEFAULT_EMAIL = '[email protected]'

spec/support/shared_contexts/instance_with_instance_methods.rb

@@ -1,4 +1,6 @@
-RSpec.shared_context 'instance with instance methods' do
+# frozen_string_literal: true
+
+RSpec.shared_examples 'instance with instance methods' do
   describe '#initialize' do
     it 'does not raise an error' do
       block_is_expected.not_to raise_error
@@ -61,9 +63,9 @@
       allow(instance).to receive(:nickname).and_return('bob')
 
       expect(instance.info).to include({
-                                   'name' => 'Bob Bobson',
-                                   'nickname' => 'bob'
-                                 })
+                                         'name' => 'Bob Bobson',
+                                         'nickname' => 'bob'
+                                       })
     end
 
     it 'uses firstname and lastname, over nickname, to set missing name' do
@@ -84,4 +86,4 @@
       expect(instance.info['name']).to eq('Awesome Dude')
     end
   end
-end
+end

spec/support/shared_contexts/model_with_class_methods.rb

@@ -1,4 +1,6 @@
-RSpec.shared_context 'model with class methods' do
+# frozen_string_literal: true
+
+RSpec.shared_examples 'model with class methods' do
   describe 'class definition' do
     it 'does not raise an error' do
       block_is_expected.not_to raise_error
@@ -15,7 +17,7 @@
     it 'calls locate with additional scopes when provided' do
       mocked_instance = double('ExampleModel', authenticate: 'abbadoo')
       allow(model_klass).to receive(:locate).with('email' => 'example',
-                                              'user_type' => 'admin').and_return(mocked_instance)
+                                                  'user_type' => 'admin').and_return(mocked_instance)
       expect(model_klass.authenticate({ 'email' => 'example', 'user_type' => 'admin' }, 'pass')).to eq('abbadoo')
     end