Spec cleanup and documentation

Author: pboling

.rubocop_todo.yml

@@ -110,7 +110,7 @@ RSpec/FilePath:
     - '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/no_brainer_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'

README.md

@@ -273,7 +273,7 @@ Please contribute some documentation if you have the gumption!  The maintainer's
 3. Commit your changes (`git commit -am ‘Added some feature’`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
-   - NOTE: In order to run *all* the tests you will need to have the following databases installed and configured.
+   - NOTE: In order to run *all* the tests you will need to have the following databases installed, configured, and running.
      1. [RethinkDB](https://rethinkdb.com), an open source, real-time, web database, [installed](https://rethinkdb.com/docs/install/) and [running](https://rethinkdb.com/docs/start-a-server/), e.g.
       ```bash
       brew install rethinkdb
@@ -283,15 +283,29 @@ Please contribute some documentation if you have the gumption!  The maintainer's
       ```bash
       brew tap mongodb/brew
       brew install [email protected]
-     
+      mongod --config /usr/local/etc/mongod.conf
       ```
-   To skip the RethinkDB-based, NoBrainer (ORM), tests run:
+      3. [CouchDB](https://couchdb.apache.org) (download the .app)
+   To run all tests on all databases:
    ```bash
-   bundle exec rspec spec --tag '~nobrainer'
+   bundle exec rake
    ```
-   Or if you have RethinkDB setup, then run all:
+   To run a specific DB:
    ```bash
-   bundle exec rspec spec
+   # 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
    ```
 6. Create new Pull Request
 

Rakefile

@@ -11,8 +11,8 @@ begin
   couch_potato.pattern = "spec_orms/couch_potato_spec.rb"
   mongoid = RSpec::Core::RakeTask.new(:spec_orm_mongoid)
   mongoid.pattern = "spec_orms/mongoid_spec.rb"
-  no_brainer = RSpec::Core::RakeTask.new(:spec_orm_no_brainer)
-  no_brainer.pattern = "spec_orms/no_brainer_spec.rb"
+  nobrainer = RSpec::Core::RakeTask.new(:spec_orm_nobrainer)
+  nobrainer.pattern = "spec_orms/nobrainer_spec.rb"
   sequel = RSpec::Core::RakeTask.new(:spec_orm_sequel)
   sequel.pattern = "spec_orms/sequel_spec.rb"
 rescue LoadError
@@ -36,6 +36,6 @@ task default: [
   :spec_orm_active_record,
   :spec_orm_couch_potato,
   :spec_orm_mongoid,
-  :spec_orm_no_brainer,
+  :spec_orm_nobrainer,
   :spec_orm_sequel
 ]

lib/omniauth/identity.rb

@@ -14,7 +14,7 @@ module Models
       autoload :ActiveRecord,      'omniauth/identity/models/active_record'
       autoload :Mongoid,           'omniauth/identity/models/mongoid'
       autoload :CouchPotatoModule, 'omniauth/identity/models/couch_potato'
-      autoload :NoBrainer,         'omniauth/identity/models/no_brainer'
+      autoload :NoBrainer,         'omniauth/identity/models/nobrainer'
       autoload :Sequel,            'omniauth/identity/models/sequel'
     end
   end

lib/omniauth/identity/models/no_brainer.rb renamed to lib/omniauth/identity/models/nobrainer.rb

@@ -4,7 +4,7 @@
 require 'active_record'
 require 'anonymous_active_record'
 
-RSpec.describe OmniAuth::Strategies::Identity do
+RSpec.describe OmniAuth::Strategies::Identity, sqlite3: true do
   attr_accessor :app
 
   let(:env_hash) { last_response.headers['env'] }

spec/omniauth/strategies/identity_spec.rb

@@ -4,7 +4,7 @@
 require 'active_record'
 require 'anonymous_active_record'
 
-RSpec.describe(OmniAuth::Identity::Models::ActiveRecord, db: :sqlite3) do
+RSpec.describe(OmniAuth::Identity::Models::ActiveRecord, sqlite3: true) do
   describe 'model', type: :model do
     subject(:model_klass) do
       AnonymousActiveRecord.generate(

spec_orms/active_record_spec.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
 require 'couch_potato'
-require 'bcrypt'
 
-RSpec.describe(OmniAuth::Identity::Models::CouchPotatoModule, db: :couchdb) do
+RSpec.describe(OmniAuth::Identity::Models::CouchPotatoModule, couchdb: true) do
   before(:all) do
     CouchPotato::Config.database_name = "http://admin:[email protected]:5984/test"
   end

spec_orms/couch_potato_spec.rb

@@ -4,7 +4,7 @@
 #       If you try it, one or both of them will not work.
 require_relative 'support/rspec_config/mongoid'
 
-RSpec.describe(OmniAuth::Identity::Models::Mongoid, db: :mongodb) do
+RSpec.describe(OmniAuth::Identity::Models::Mongoid, mongodb: true) do
   describe 'model', type: :model do
     subject(:model_klass) { MongoidTestIdentity }
 

spec_orms/mongoid_spec.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# NOTE: mongoid and no_brainer can't be loaded at the same time.
+# NOTE: mongoid and nobrainer can't be loaded at the same time.
 #       If you try it, one or both of them will not work.
 require 'nobrainer'
 
-RSpec.describe(OmniAuth::Identity::Models::NoBrainer, db: :rethinkdb) do
+RSpec.describe(OmniAuth::Identity::Models::NoBrainer, rethinkdb: true) do
   before(:all) do
     NoBrainer.configure do |config|
       config.app_name = 'DeezBrains'