rodauth-model 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ea8768862eb1ba1bf2bdf1bb93872c0167230bf8c139ca49db5b17927288797
-  data.tar.gz: fe85b970b503ecd33a9c074d1b8763616e65fac5e88fd0fbbd49d2b986ae29ea
+  metadata.gz: 59bbf27ffd624fa72ce609fcb9968118bf358e3e3f10893db7d0d73abf356d12
+  data.tar.gz: 2c286827b98cef9f1d593f740375ae2f74c759dee7dd2d7c954380a03659ecd4
 SHA512:
-  metadata.gz: 4b3f777be5c15eadacb69e074a4bf7b9aacad161e3b6c98f4c2f7ac0a3712af07259e82e62b339e18539522d98694d5d38d95318a11b10cac43c3cf042e87f0e
-  data.tar.gz: 7788e39bd9de5138773a90c5cac2babdef39da6b9a2a557a37af902c4b1bc851ec26e7e09dd6c6a62d799c3b39198750c39a24560025c2acb7e9fb0223bb4379
+  metadata.gz: a8ef44bd93fc5cdb4fabaf58544bcf3ddc7ab8084a6a38b73777cb26163fe0ad8ded45978975cf4423b8f44b97e1c49dc9d3d01f6ca7aac71f06d120a7bebf5b
+  data.tar.gz: 9d8067365baec855fed3ad8f2db189d8842e3244b2867ca6b67413715ddd15465aa7f5db1d416f80e4925df2b226f7edda80e68cd40a83a0697e7a1cfe669644

data/CHANGELOG.md

@@ -1,5 +1,13 @@
-## [Unreleased]
+## 0.2.1 (2022-10-26)
 
-## [0.1.0] - 2022-01-04
+* Fix `elsif` warning in sequel code (@janko)
 
-- Initial release
+## 0.2.0 (2022-05-11)
+
+* Add support for Sequel models (@janko)
+
+* Delete associated authentication audit logs after destroying account (@janko)
+
+## 0.1.0 (2022-05-07)
+
+* Initial release (@janko)

data/README.md

@@ -1,6 +1,6 @@
 # rodauth-model
 
-Extension for [Rodauth] providing a mixin for the account model that defines password attribute and associations based on enabled authentication features. At the moment only Active Record is supported.
+Extension for [Rodauth] providing a mixin for the account model that defines password attribute and associations based on enabled authentication features. Supports both Active Record and Sequel models.
 
 ## Installation
 
@@ -10,7 +10,7 @@ $ bundle add rodauth-model
 
 ## Usage
 
-Assuming with have a `RodauthApp` Roda subclass with Rodauth configured, we can build the mixin from a Rodauth class, and include it into the account model:
+The model mixin is built by calling `Rodauth::Model(...)` with the Rodauth auth class, and included into the account model:
 
 ```rb
 require "rodauth/model" # require before enabling any authentication features
@@ -22,7 +22,7 @@ class RodauthApp < Roda
 end
 ```
 ```rb
-class Account < ActiveRecord::Base
+class Account < ActiveRecord::Base # Sequel::Model
   include Rodauth::Model(RodauthApp.rodauth)
 end
 ```
@@ -30,7 +30,7 @@ end
 If you have multiple Rodauth configurations, pass the one for which you want associations to be defined.
 
 ```rb
-class Account < ActiveRecord::Base
+class Account < ActiveRecord::Base # Sequel::Model
   include Rodauth::Model(RodauthApp.rodauth(:admin))
 end
 ```
@@ -40,7 +40,7 @@ end
 Regardless of whether you're storing the password hash in a column in the accounts table, or in a separate table, the `#password` attribute can be used to set or clear the password hash.
 
 ```rb
-account = Account.create!(email: "user@example.com", password: "secret")
+account = Account.create(email: "user@example.com", password: "secret")
 
 # when password hash is stored in a column on the accounts table
 account.password_hash #=> "$2a$12$k/Ub1I2iomi84RacqY89Hu4.M0vK7klRnRtzorDyvOkVI.hKhkNw."
@@ -71,23 +71,23 @@ You can also reference the associated models directly:
 Account::AuthenticationAuditLog.where(message: "login").group(:account_id)
 ```
 
-The associated models define the inverse `belongs_to :account` association:
+The associated models define the inverse `account` association:
 
 ```rb
-Account::ActiveSessionKey.includes(:account).map(&:account)
+Account::ActiveSessionKey.eager(:account).map(&:account)
 ```
 
 ### Association options
 
-By default, all associations except for audit logs have `dependent: :delete` set, to allow for easy deletion of account records in the console. You can use `:association_options` to modify global or per-association options:
+By default, all associations are configured to be deleted when the associated account record is deleted. When using Active Record, you can use `:association_options` to modify global or per-association options:
 
 ```rb
-# don't auto-delete associations when account model is deleted
+# don't auto-delete associations when account model is deleted (Active Record)
 Rodauth::Model(RodauthApp.rodauth, association_options: { dependent: nil })
 
-# require authentication audit logs to be eager loaded before retrieval
+# require authentication audit logs to be eager loaded before retrieval (Sequel)
 Rodauth::Model(RodauthApp.rodauth, association_options: -> (name) {
-  { strict_loading: true } if name == :authentication_audit_logs
+  { forbid_lazy_load: true } if name == :authentication_audit_logs
 })
 ```
 
@@ -117,7 +117,7 @@ Below is a list of all associations defined depending on the features loaded:
 | webauthn                | `:webauthn_keys`             | `has_many` | `WebauthnKey`            | `account_webauthn_keys`             |
 | webauthn                | `:webauthn_user_id`          | `has_one`  | `WebauthnUserId`         | `account_webauthn_user_ids`         |
 
-Note that some Rodauth tables use composite primary keys, which Active Record doesn't support out of the box. For associations to work properly, you might need to add the [composite_primary_keys] gem to your Gemfile.
+Note that some Rodauth tables use composite primary keys, which Active Record doesn't support out of the box. For associations to work properly in Active Record, you might need to add the [composite_primary_keys] gem to your Gemfile. On Sequel, associations will work without any changes, because Sequel supports composite primary keys.
 
 ## Extending associations
 
@@ -178,10 +178,6 @@ end
 
 ## Future plans
 
-### Sequel support
-
-Currently on Active Record models are supported, but I would like support Sequel models in the near future as well.
-
 ### Joined associations
 
 It's possible to have multiple Rodauth configurations that operate on the same tables, but it's currently possible to define associations just for a single configuration. I would like to support grabbing associations from multiple associations.

data/lib/rodauth/model/active_record.rb

@@ -68,14 +68,10 @@ module Rodauth
 
         model.const_set(name.to_s.singularize.camelize, associated_model)
 
-        unless name == :authentication_audit_logs
-          dependent = type == :has_many ? :delete_all : :delete
-        end
-
         model.public_send type, name, scope,
           class_name: associated_model.name,
           foreign_key: foreign_key,
-          dependent: dependent,
+          dependent: type == :has_many ? :delete_all : :delete,
           inverse_of: :account,
           **options,
           **association_options(name)

data/lib/rodauth/model/sequel.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "sequel"
+
+module Rodauth
+  class Model
+    module Sequel
+      include ::Sequel::Inflections
+
+      ASSOCIATION_TYPES = { one: :one_to_one, many: :one_to_many }
+
+      private
+
+      def define_methods(model)
+        rodauth = @auth_class.allocate.freeze
+
+        unless rodauth.account_password_hash_column
+          model.plugin :nested_attributes
+          model.nested_attributes :password_hash, destroy: true
+        end
+
+        attr_reader :password
+
+        define_method(:password=) do |password|
+          @password = password
+          password_hash = rodauth.send(:password_hash, password) if password
+          set_password_hash(password_hash)
+        end
+
+        define_method(:set_password_hash) do |password_hash|
+          if rodauth.account_password_hash_column
+            public_send(:"#{rodauth.account_password_hash_column}=", password_hash)
+          else
+            return if password_hash.nil? && self.password_hash.nil?
+
+            attributes = { rodauth.password_hash_id_column => self.password_hash&.pk }.compact
+            if password_hash
+              attributes[rodauth.password_hash_column] = password_hash
+            else
+              attributes[:_delete] = true
+            end
+            self.password_hash_attributes = attributes
+          end
+        end
+      end
+
+      def define_associations(model)
+        model.plugin :association_dependencies
+
+        define_password_hash_association(model) unless rodauth.account_password_hash_column
+
+        feature_associations.each do |association|
+          association[:type] = ASSOCIATION_TYPES.fetch(association[:type])
+
+          define_association(model, **association)
+        end
+      end
+
+      def define_password_hash_association(model)
+        select = [rodauth.password_hash_id_column] if rodauth.send(:use_database_authentication_functions?)
+
+        define_association model,
+          type: :one_to_one,
+          name: :password_hash,
+          table: rodauth.password_hash_table,
+          key: rodauth.password_hash_id_column,
+          select: select
+      end
+
+      def define_association(model, type:, name:, table:, key:, **options)
+        associated_model = Class.new(::Sequel::Model)
+        associated_model.set_dataset(model.db[table])
+        associated_model.many_to_one :account, class: model.name, key: key
+
+        model.const_set(camelize(singularize(name.to_s)), associated_model)
+
+        model.public_send type, name,
+          class: associated_model.name,
+          key: key,
+          **options,
+          **association_options(name)
+
+        model.add_association_dependencies name => :delete
+      end
+
+      def association_options(name)
+        options = @association_options
+        options = options.call(name) if options.respond_to?(:call)
+        options || {}
+      end
+    end
+  end
+end

data/lib/rodauth/model.rb

@@ -9,6 +9,7 @@ module Rodauth
     Error = Class.new(StandardError)
 
     autoload :ActiveRecord, "rodauth/model/active_record"
+    autoload :Sequel, "rodauth/model/sequel"
 
     def self.associations
       @associations ||= {}
@@ -28,9 +29,9 @@ module Rodauth
       if defined?(::ActiveRecord::Base) && model < ::ActiveRecord::Base
         extend Rodauth::Model::ActiveRecord
       elsif defined?(::Sequel::Model) && model < ::Sequel::Model
-        raise Error, "Sequel models are not yet supported"
+        extend Rodauth::Model::Sequel
       else
-        raise Error, "must be an Active Record model"
+        raise Error, "must be an Active Record or Sequel model"
       end
 
       define_associations(model)

data/rodauth-model.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "rodauth-model"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.1"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko@hey.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-07 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rodauth
@@ -137,6 +137,7 @@ files:
 - lib/rodauth/model.rb
 - lib/rodauth/model/active_record.rb
 - lib/rodauth/model/associations.rb
+- lib/rodauth/model/sequel.rb
 - rodauth-model.gemspec
 homepage: https://github.com/janko/rodauth-model
 licenses: