👷 Workflows: fix CouchDB initialization for tests

Author: pboling

.envrc

@@ -20,7 +20,7 @@ export K_SOUP_COV_DO=true # Means you want code coverage
 export K_SOUP_COV_COMMAND_NAME="RSpec Coverage"
 export K_SOUP_COV_FORMATTERS="html,tty"
 export K_SOUP_COV_MIN_BRANCH=80 # Means you want to enforce X% branch coverage
-export K_SOUP_COV_MIN_LINE=69 # Means you want to enforce X% line coverage
+export K_SOUP_COV_MIN_LINE=91 # Means you want to enforce X% line coverage
 export K_SOUP_COV_MIN_HARD=true # Means you want the build to fail if the coverage thresholds are not met
 export K_SOUP_COV_MULTI_FORMATTERS=true
 export MAX_ROWS=1 # Setting for simplecov-console gem for tty output, limits to the worst N rows of bad coverage

.github/workflows/coverage.yml

@@ -2,7 +2,7 @@ name: Ruby - Coverage
 
 env:
   K_SOUP_COV_MIN_BRANCH: 80
-  K_SOUP_COV_MIN_LINE: 69
+  K_SOUP_COV_MIN_LINE: 91
   K_SOUP_COV_MIN_HARD: true
   K_SOUP_COV_DO: true
   K_SOUP_COV_COMMAND_NAME: "RSpec Coverage"

.github/workflows/unsupported.yml

@@ -35,9 +35,6 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        gemfile: "Appraisal.root"
-        rubygems: '3.4.22'
-        bundler: '2.4.22'
         include:
           # Ruby 2.6
           - ruby: "2.6"

README.md

@@ -282,42 +282,77 @@ 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, 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
-       rethinkdb
-       ```
-        2. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/)
-       ```bash
-       brew tap mongodb/brew
-       brew install mongodb-community@4.4
-       mongod --config /usr/local/etc/mongod.conf
-       ```
-        3. [CouchDB](https://couchdb.apache.org) (download the .app)
-
-      To run all tests on all databases (except RethinkDB):
-        ```bash
-        bundle exec rake spec
-        ```
-      To run a specific DB:
-        ```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 (Ignored by CI! see spec file for more)
-        bundle exec rspec spec_ignored/nobrainer_spec.rb
-        ```
-6. Create new Pull Request
+
+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
+   rethinkdb
+   ```
+2. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/)
+   ```bash
+   brew tap mongodb/brew
+   brew install mongodb-community@4.4
+   mongod --config /usr/local/etc/mongod.conf
+   ```
+3. [CouchDB](https://couchdb.apache.org) - download the .app, or:
+   ```bash
+   brew install couchdb
+   ```
+   CouchDB 3.x requires a set admin password set before startup.
+   Add one to your `$HOMEBREW_PREFIX/etc/local.ini` before starting CouchDB e.g.:
+   ```ini
+   [admins]
+   admin = yourabsolutesecret
+   ```
+   Also add whatever password you set to your `.env.local`:
+   ```dotenv
+   export COUCHDB_PASSWORD=yourabsolutesecret
+   ```
+   Then start the CouchDB service
+   ```bash
+   brew services start couchdb
+   ```
+
+Now you can run any of the tests!
+
+To run all tests on all databases (except RethinkDB):
+```bash
+bundle exec rake spec:orm:all
+```
+
+To run all tests that do not require any additional services, like MongoDB, CouchDB, or RethinkDB:
+```bash
+bundle exec rake test
+```
+
+To run a specific DB:
+```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 (Ignored by CI! see spec file for reasons)
+bundle exec rspec spec_ignored/nobrainer_spec.rb
+```
+
+### Finally
+
+Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
+```bash
+bundle exec rake
+```
+
+📌 Create new Pull Request with your changes 📌
 
 ## License
 

lib/omniauth/identity/models/couch_potato.rb

@@ -17,7 +17,7 @@ def self.included(base)
             include(::OmniAuth::Identity::SecurePassword)
 
             # validations: true (default) incurs a dependency on ActiveModel, but CouchPotato is ActiveModel based.
-            has_secure_password(validations: false)
+            has_secure_password
 
             def self.auth_key=(key)
               super
@@ -29,7 +29,7 @@ def self.locate(search_hash)
             end
 
             def save
-              CouchPotato.database.save(self)
+              CouchPotato.database.save_document(self)
             end
           end
         end

lib/omniauth/identity/models/sequel.rb

@@ -31,6 +31,7 @@ def self.included(base)
 
             def self.auth_key=(key)
               super
+              # Sequel version of validates_uniqueness_of! Does not incur ActiveRecord dependency!
               validates_uniqueness_of(:key, case_sensitive: false)
             end
 

spec/support/shared_contexts/persistable_model.rb

@@ -8,16 +8,29 @@
 
     include_context "instance with instance methods"
 
+    before do
+      instance.email = DEFAULT_EMAIL
+      instance.password = DEFAULT_PASSWORD
+      instance.password_confirmation = DEFAULT_PASSWORD
+    end
+
+    describe "#valid?" do
+      subject(:is_valid) do
+        instance.valid?
+      end
+
+      it "is valid" do
+        expect(is_valid).to eq(true)
+      end
+    end
+
     describe "#save" do
-      subject(:save) do
-        instance.email = DEFAULT_EMAIL
-        instance.password = DEFAULT_PASSWORD
-        instance.password_confirmation = DEFAULT_PASSWORD
+      subject(:is_saved) do
         instance.save
       end
 
       it "does not raise an error" do
-        save
+        block_is_expected.not_to raise_error
       end
     end
   end

spec_orms/couch_potato_spec.rb

@@ -4,7 +4,9 @@
 
 RSpec.describe(OmniAuth::Identity::Models::CouchPotatoModule, :couchdb) do
   before(:all) do
-    CouchPotato::Config.database_name = "http://admin:password@127.0.0.1:5984/"
+    CouchPotato::Config.database_host = "http://admin:#{ENV.fetch("COUCHDB_PASSWORD", "password")}@127.0.0.1:5984"
+    CouchPotato::Config.database_name = "test"
+    CouchPotato.couchrest_database.recreate!
   end
 
   before do