♻️ Refactor spec support harness for ROM

Author: pboling

.rubocop_gradual.lock

@@ -1,6 +1,6 @@
 {
-  "README.md:2294530640": [
-    [275, 3, 100, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3592044714]
+  "README.md:2478083419": [
+    [277, 3, 100, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3592044714]
   ],
   "bin/bundle:247448467": [
     [64, 5, 20, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 2485198147]
@@ -31,13 +31,12 @@
     [57, 13, 125, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3604044426],
     [69, 13, 83, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 902334745]
   ],
-  "lib/omniauth/identity/models/rom.rb:4274893658": [
-    [23, 9, 804, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 2641680277],
+  "lib/omniauth/identity/models/rom.rb:1077115502": [
+    [23, 9, 814, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 2641680277],
     [34, 33, 14, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 3392992668],
-    [34, 48, 15, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 3094507655],
-    [51, 13, 15, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 1768297560],
-    [67, 18, 20, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 2230320645],
-    [68, 54, 20, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 2230320645]
+    [56, 13, 15, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 1768297560],
+    [72, 18, 20, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 2230320645],
+    [73, 54, 20, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 2230320645]
   ],
   "lib/omniauth/identity/models/sequel.rb:101522047": [
     [44, 9, 3379, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3595458005]
@@ -103,15 +102,13 @@
     [14, 1, 61, "RSpec/SpecFilePathFormat: Spec path should end with `omni_auth/identity/models/mongoid*_spec.rb`.", 2184534986],
     [32, 9, 71, "RSpec/SubjectStub: Do not stub methods of the object under test.", 399334056]
   ],
-  "spec_orms/rom_spec.rb:2718230340": [
-    [42, 1, 57, "RSpec/SpecFilePathFormat: Spec path should end with `omni_auth/identity/models/rom*_spec.rb`.", 18469108],
-    [43, 3, 254, "RSpec/LeakyConstantDeclaration: Stub constant instead of declaring explicitly.", 151871654],
-    [51, 3, 12, "RSpec/BeforeAfterAll: Beware of using `before(:all)` as it may cause state to leak between tests. If you are using `rspec-rails`, and `use_transactional_fixtures` is enabled, then records created in `before(:all)` are not automatically rolled back.", 86334566]
+  "spec_orms/rom_spec.rb:1364234352": [
+    [5, 1, 57, "RSpec/SpecFilePathFormat: Spec path should end with `omni_auth/identity/models/rom*_spec.rb`.", 18469108],
+    [6, 3, 12, "RSpec/BeforeAfterAll: Beware of using `before(:all)` as it may cause state to leak between tests. If you are using `rspec-rails`, and `use_transactional_fixtures` is enabled, then records created in `before(:all)` are not automatically rolled back.", 86334566]
   ],
-  "spec_orms/sequel_spec.rb:1275922107": [
-    [22, 1, 60, "RSpec/SpecFilePathFormat: Spec path should end with `omni_auth/identity/models/sequel*_spec.rb`.", 36626431],
-    [23, 3, 12, "RSpec/BeforeAfterAll: Beware of using `before(:all)` as it may cause state to leak between tests. If you are using `rspec-rails`, and `use_transactional_fixtures` is enabled, then records created in `before(:all)` are not automatically rolled back.", 86334566],
-    [34, 7, 42, "Layout/EmptyLinesAfterModuleInclusion: Add an empty line after module inclusion.", 1846499429],
-    [48, 9, 71, "RSpec/SubjectStub: Do not stub methods of the object under test.", 399334056]
+  "spec_orms/sequel_spec.rb:1276231279": [
+    [12, 1, 60, "RSpec/SpecFilePathFormat: Spec path should end with `omni_auth/identity/models/sequel*_spec.rb`.", 36626431],
+    [13, 3, 12, "RSpec/BeforeAfterAll: Beware of using `before(:all)` as it may cause state to leak between tests. If you are using `rspec-rails`, and `use_transactional_fixtures` is enabled, then records created in `before(:all)` are not automatically rolled back.", 86334566],
+    [39, 9, 71, "RSpec/SubjectStub: Do not stub methods of the object under test.", 399334056]
   ]
 }

README.md

@@ -167,14 +167,16 @@ This gem is compatible with a wide range of Ruby versions and Ruby ORMs, as of M
   * mongoid 7.3, 7.4, 8.1, 9.0
   * bson 4.12, 4.15, 5.0, HEAD
   * sequel 5.86+
-* At least 5 different database ORM adapters, which connect to 15 different database clients!
+  * rom-sql (Ruby Object Mapper) 3.7+
+* At least 6 different database ORM adapters, which connect to 15 different database clients!
 
 | Databases                                                                                                 | Adapter Libraries                                                        |
-| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
+|-----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
 | MySQL, MariaDB, PostgreSQL, SQLite                                                                        | [ActiveRecord](https://guides.rubyonrails.org/active_record_basics.html) |
 | CouchDB                                                                                                   | [CouchPotato](https://github.com/langalex/couch_potato)                  |
 | MongoDB                                                                                                   | [Mongoid](https://github.com/mongodb/mongoid)                            |
 | RethinkDB                                                                                                 | [NoBrainer](http://nobrainer.io/)                                        |
+| ADO, Amalgalite, IBM_DB, JDBC, MySQL, MariaDB, ODBC, Oracle, PostgreSQL, SQLAnywhere, SQLite, and TinyTDS | [rom-sql](https://rom-rb.org/)                                           |
 | ADO, Amalgalite, IBM_DB, JDBC, MySQL, MariaDB, ODBC, Oracle, PostgreSQL, SQLAnywhere, SQLite, and TinyTDS | [Sequel](http://sequel.jeremyevans.net)                                  |
 
 ## 🔧 Basic Usage
@@ -298,7 +300,23 @@ end
 
 ### Ruby Object Mapper
 
-Would love to add a mixin for the [Ruby Object Mapper (ROM)](https://rom-rb.org/) if anyone wants to work on it!
+[ROM](https://rom-rb.org/) is an ORM for pretty much every database.
+
+Include the `OmniAuth::Identity::Models::Rom` mixin and specify
+the `rom_container`, everything else is optional.
+
+```ruby
+class Identity
+  include OmniAuth::Identity::Models::Rom
+
+  # Configure the ROM container and relation
+  self.rom_container = -> { MyDatabase.rom } # See spec_orms/rom_spec.rb for example
+  self.rom_relation_name = :identities # optional, defaults to :idneitities
+  self.owner_relation_name = :owners  # optional, for loading associated owner
+  self.auth_key_field = :email  # optional, defaults to :email
+  self.password_field = :password_digest  # optional, defaults to :password_digest
+end
+```
 
 ### Custom Auth Model
 

lib/omniauth/identity/models/rom.rb

@@ -2,6 +2,9 @@
 
 require "bcrypt"
 
+require "rom"
+require "rom-sql"
+
 module OmniAuth
   module Identity
     module Models
@@ -14,7 +17,7 @@ module Models
       #
       #     # Configure the ROM container and relation
       #     self.rom_container = -> { MyDatabase.rom } # See spec_orms/rom_spec.rb for example
-      #     self.rom_relation_name = :identities
+      #     self.rom_relation_name = :identities # optional, defaults to :idneitities
       #     self.owner_relation_name = :owners  # optional, for loading associated owner
       #     self.auth_key_field = :email  # optional, defaults to :email
       #     self.password_field = :password_digest  # optional, defaults to :password_digest
@@ -76,8 +79,6 @@ def locate(conditions)
               else
                 new(identity_data)
               end
-            else
-              nil
             end
           end
         end

rom_spec_refactored.txt

@@ -0,0 +1,27 @@
+LOADING DEBUGGER: true
+
+Randomized with seed 27610
+
+OmniAuth::Identity::Models::Rom
+  model
+    ::authenticate
+      calls locate with additional scopes when provided
+      recovers gracefully if locate is nil
+      calls locate and then authenticate
+    ::locate
+      returns nil if not found
+      finds a record by auth key
+    class definition
+      does not raise an error
+    owner_relation_name
+      loads associated owner data when owner_relation_name is configured
+    ::authenticate
+      returns false with incorrect password
+      returns false for non-existent user
+      authenticates with correct password
+
+Finished in 1.89 seconds (files took 0.98284 seconds to load)
+10 examples, 0 failures
+
+Randomized with seed 27610
+

spec_orms/rom_spec.rb

@@ -1,82 +1,27 @@
 # frozen_string_literal: true
 
-# Bugfixes
-# JRuby needed an explicit "require 'logger'" for Rails < 7.1
-# See: https://github.com/rails/rails/issues/54260#issuecomment-2594650047
-# Placing above omniauth because it is a dependency of omniauth,
-#   which is undeclared in older versions.
-require "logger"
-
-# :nocov:
-DB = if RUBY_ENGINE == "jruby"
-  require "jdbc/sqlite3"
-  require "sequel"
-  Sequel.connect("jdbc:sqlite::memory:")
-else
-  require "sqlite3"
-  require "sequel"
-  Sequel.sqlite
-end
-# :nocov:
-
-require "rom"
-require "rom-sql"
-
-# Define the ROM relations
-class RomTestIdentities < ROM::Relation[:sql]
-  schema(:rom_test_identities) do
-    attribute :id, ROM::SQL::Types::Serial
-    attribute :email, ROM::SQL::Types::String
-    attribute :password_digest, ROM::SQL::Types::String
-    attribute :owner_id, ROM::SQL::Types::Integer
-  end
-end
-
-class RomTestOwners < ROM::Relation[:sql]
-  schema(:rom_test_owners) do
-    attribute :id, ROM::SQL::Types::Serial
-    attribute :name, ROM::SQL::Types::String
-  end
-end
+require_relative "support/rspec_config/rom"
 
 RSpec.describe(OmniAuth::Identity::Models::Rom, :sqlite3) do
-  ROM_CONTAINER = begin
-    # Set up ROM container with Sequel adapter
-    rom_config = ROM::Configuration.new(:sql, DB)
-    rom_config.register_relation(RomTestIdentities)
-    rom_config.register_relation(RomTestOwners)
-    ROM.container(rom_config)
-  end
-
   before(:all) do
     # Create the tables
-    DB.create_table(:rom_test_identities) do
+    ROM_DB.create_table(:rom_test_identities) do
       primary_key :id
       String :email, null: false
       String :password_digest, null: false
       Integer :owner_id
     end
 
-    DB.create_table(:rom_test_owners) do
+    ROM_DB.create_table(:rom_test_owners) do
       primary_key :id
       String :name, null: false
     end
   end
 
   before do
     # Clear the tables before each test
-    DB[:rom_test_identities].delete
-    DB[:rom_test_owners].delete
-
-    rom_test_identity = Class.new do
-      include OmniAuth::Identity::Models::Rom
-
-      self.rom_container = ROM_CONTAINER
-      self.rom_relation_name = :rom_test_identities
-      self.auth_key_field = :email
-      self.password_field = :password_digest
-    end
-    stub_const("RomTestIdentity", rom_test_identity)
+    ROM_DB[:rom_test_identities].delete
+    ROM_DB[:rom_test_owners].delete
   end
 
   describe "model", type: :model do

spec_orms/sequel_spec.rb

@@ -7,17 +7,7 @@
 #   which is undeclared in older versions.
 require "logger"
 
-# :nocov:
-DB = if RUBY_ENGINE == "jruby"
-  require "jdbc/sqlite3"
-  require "sequel"
-  Sequel.connect("jdbc:sqlite::memory:")
-else
-  require "sqlite3"
-  require "sequel"
-  Sequel.sqlite
-end
-# :nocov:
+require_relative "support/rspec_config/sequel"
 
 RSpec.describe(OmniAuth::Identity::Models::Sequel, :sqlite3) do
   before(:all) do
@@ -30,8 +20,9 @@
   end
 
   before do
-    sequel_test_identity = Class.new(Sequel::Model(:sequel_test_identities)) do
+    sequel_test_identity = Class.new(Sequel::Model(DB[:sequel_test_identities])) do
       include OmniAuth::Identity::Models::Sequel
+
       auth_key :email
     end
     stub_const("SequelTestIdentity", sequel_test_identity)

spec_orms/support/rspec_config/rom.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "logger"
+
+# :nocov:
+ROM_DB = if RUBY_ENGINE == "jruby"
+  require "jdbc/sqlite3"
+  require "sequel"
+  Sequel.connect("jdbc:sqlite::memory:rom")
+else
+  require "sqlite3"
+  require "sequel"
+  Sequel.connect("sqlite::memory:rom")
+end
+# :nocov:
+
+require "rom"
+require "rom-sql"
+
+# Define the ROM relations
+class RomTestIdentities < ROM::Relation[:sql]
+  schema(:rom_test_identities) do
+    attribute :id, ROM::SQL::Types::Serial
+    attribute :email, ROM::SQL::Types::String
+    attribute :password_digest, ROM::SQL::Types::String
+    attribute :owner_id, ROM::SQL::Types::Integer
+  end
+end
+
+class RomTestOwners < ROM::Relation[:sql]
+  schema(:rom_test_owners) do
+    attribute :id, ROM::SQL::Types::Serial
+    attribute :name, ROM::SQL::Types::String
+  end
+end
+
+# Set up ROM container
+ROM_CONFIG = ROM::Configuration.new(:sql, ROM_DB)
+ROM_CONFIG.register_relation(RomTestIdentities)
+ROM_CONFIG.register_relation(RomTestOwners)
+ROM_CONTAINER = ROM.container(ROM_CONFIG)
+
+class RomTestIdentity
+  include OmniAuth::Identity::Models::Rom
+
+  self.rom_container = ROM_CONTAINER
+  self.rom_relation_name = :rom_test_identities
+  self.auth_key_field = :email
+  self.password_field = :password_digest
+end

spec_orms/support/rspec_config/sequel.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "logger"
+
+# :nocov:
+DB = if RUBY_ENGINE == "jruby"
+  require "jdbc/sqlite3"
+  require "sequel"
+  Sequel.connect("jdbc:sqlite::memory:sequel")
+else
+  require "sqlite3"
+  require "sequel"
+  Sequel.connect("sqlite::memory:sequel")
+end
+# :nocov: