Add #password? method

It's shorter and nicer way than `#password_hash` to check whether a password is
set.

Author: janko

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.0 (2024-12-16)
+
+* Add `password?` model method that returns whether a password is set (@janko)
+
 ## 0.3.0 (2024-10-12)
 
 * Add support for OTP Unlock feature (@janko)

README.md

@@ -41,8 +41,12 @@ account.password_hash #=> "$2a$12$k/Ub1I2iomi84RacqY89Hu4.M0vK7klRnRtzorDyvOkVI.
 account.password_hash #=> #<Account::PasswordHash...> (record from `account_password_hashes` table)
 account.password_hash.password_hash #=> "$2a$12$k/Ub1..." (inaccessible when using database authentication functions)
 
+# whether a password is set
+account.password? #=> true
+
 account.password = nil # clears password hash
 account.password_hash #=> nil
+account.password? #=> false
 ```
 
 Note that the password attribute doesn't come with validations, making it unsuitable for forms. It was primarily intended to allow easily creating accounts in development console and in tests.

lib/rodauth/model/active_record.rb

@@ -32,6 +32,14 @@ def define_methods(model)
             end
           end
         end
+
+        define_method(:password?) do
+          if rodauth.account_password_hash_column
+            !!public_send(rodauth.account_password_hash_column)
+          else
+            !!password_hash
+          end
+        end
       end
 
       def define_associations(model)

lib/rodauth/model/sequel.rb

@@ -42,6 +42,14 @@ def define_methods(model)
             self.password_hash_attributes = attributes
           end
         end
+
+        define_method(:password?) do
+          if rodauth.account_password_hash_column
+            !!public_send(rodauth.account_password_hash_column)
+          else
+            !!password_hash
+          end
+        end
       end
 
       def define_associations(model)

test/active_record_test.rb

@@ -30,6 +30,7 @@
 
     account.password = "secret"
     assert_equal "secret", account.password
+    assert_equal true, account.password?
 
     refute_nil account.password_hash
     assert_operator BCrypt::Password.new(account.password_hash), :==, "secret"
@@ -42,13 +43,15 @@
 
     account.password = nil
     assert_nil account.password_hash
+    assert_equal false, account.password?
   end
 
   it "defines password attribute with a table" do
     account = build_account { account_password_hash_column nil }
 
     account.password = "secret"
     assert_equal "secret", account.password
+    assert_equal true, account.password?
 
     assert_instance_of Account::PasswordHash, account.password_hash
     assert_operator BCrypt::Password.new(account.password_hash.password_hash), :==, "secret"
@@ -75,6 +78,7 @@
 
     account.reload
     assert_nil account.password_hash
+    assert_equal false, account.password?
   end
 
   it "doesn't select password hash column when using database authentication functions" do

test/sequel_test.rb

@@ -21,6 +21,7 @@
 
     account.password = "secret"
     assert_equal "secret", account.password
+    assert_equal true, account.password?
 
     refute_nil account.password_hash
     assert_operator BCrypt::Password.new(account.password_hash), :==, "secret"
@@ -33,13 +34,15 @@
 
     account.password = nil
     assert_nil account.password_hash
+    assert_equal false, account.password?
   end
 
   it "defines password attribute with a table" do
     account = build_account { account_password_hash_column nil }
 
     account.password = "secret"
     assert_equal "secret", account.password
+    assert_equal true, account.password?
 
     assert_instance_of Account::PasswordHash, account.password_hash
     assert_operator BCrypt::Password.new(account.password_hash.password_hash), :==, "secret"
@@ -66,6 +69,7 @@
 
     account.reload
     assert_nil account.password_hash
+    assert_equal false, account.password?
   end
 
   it "doesn't select password hash column when using database authentication functions" do