rodauth-rails 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e46466d584d7579c32e7d7e53335260dd137c04371f4b7c4680caa5c6a4e4147
-  data.tar.gz: c0be8bdc56f5214c885fc5ad990a0be511251cab6dbf9b0ec7aa3fbd8631d0c9
+  metadata.gz: 1539e5f70a8cefa3c40e06b5b177152e4772f099deb11a077f07f59529622a62
+  data.tar.gz: 67c9a6829f8a9c45708cb1ab0781a2eebe1998d5f31f66b26d5c7f58cb37cdf8
 SHA512:
-  metadata.gz: 8428739e888033efa811819ee8561fa3f2ae342074f6e27bbf257c18bf7029ab87380a82c75c6c08de2a0d4de49482eac74a32bc7aaf0579baf45978fe63811c
-  data.tar.gz: d626ea202fe8e371e6c77364a9e3c1ef34fdccff0ce7794c54b3fc748b0e1a764e92b99b6b7f06aaa8e2f2f67b155b127c0b1314d4ec7420637013136170141c
+  metadata.gz: bf1f132504de2266dc4ef7f71ffdd630e348119f6681f84288aeb6ba24481336948c78183d4fa7e90100dedc85e04c4bb98f915de3ecf156630d523d91d74c00
+  data.tar.gz: e1858507c3ee9a2855e04fa67957859f41347adbf448793b8cebe263a0bd95517ef913b4132470a31609be9741ff73e4769309df5924f19b0db0503a1a25fa2a

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.17.0 (2021-10-05)
+
+* Set `delete_account_on_close?` to `true` in generated `rodauth_app.rb` (@janko)
+
+* Change default `:dependent` option for associations to `:delete`/`:delete_all` (@janko)
+
+* Add `rails_account_model` configuration method for when the account model cannot be inferred (@janko)
+
 ## 0.16.0 (2021-09-26)
 
 * Add `#current_account` to methods defined on `ActionController::Base` (@janko)

data/README.md

@@ -49,7 +49,7 @@ For instructions on upgrading from previous rodauth-rails versions, see
 Add the gem to your Gemfile:
 
 ```rb
-gem "rodauth-rails", "~> 0.16"
+gem "rodauth-rails", "~> 0.17"
 
 # gem "jwt",      require: false # for JWT feature
 # gem "rotp",     require: false # for OTP feature
@@ -150,6 +150,9 @@ current_account #=> #<Account id=123 email="user@example.com">
 current_account.email #=> "user@example.com"
 ```
 
+If the account doesn't exist in the database, the session will be cleared and
+login required.
+
 Pass the configuration name to retrieve accounts belonging to other Rodauth
 configurations:
 
@@ -157,8 +160,19 @@ configurations:
 current_account(:admin)
 ```
 
-If the account doesn't exist in the database, the session will be cleared and
-login required.
+The `#current_account` method will try to infer the account model class from
+the configured table name. If that fails, you can set the account model
+manually:
+
+```rb
+# app/lib/rodauth_app.rb
+class RodauthApp < Rodauth::Rails::App
+  configure do
+    # ...
+    rails_account_model Authentication::Account # custom model name
+  end
+end
+```
 
 ### Requiring authentication
 
@@ -777,11 +791,52 @@ end
 
 ### Outside of a request
 
-In some cases you might need to use Rodauth more programmatically. If you would
-like to perform Rodauth operations outside of request context, Rodauth ships
-with the [internal_request] feature just for that. The rodauth-rails gem
-additionally updates the internal rack env hash with your
-`config.action_mailer.default_url_options`, which is used for generating URLs.
+In some cases you might need to use Rodauth more programmatically. If you want
+to perform authentication operations outside of request context, Rodauth ships
+with the [internal_request] feature just for that.
+
+```rb
+# app/lib/rodauth_app.rb
+class RodauthApp < Rodauth::Rails::App
+  configure do
+    enable :internal_request
+  end
+end
+```
+```rb
+# main configuration
+RodauthApp.rodauth.create_account(login: "user@example.com", password: "secret")
+RodauthApp.rodauth.verify_account(account_login: "user@example.com")
+
+# secondary configuration
+RodauthApp.rodauth(:admin).close_account(account_login: "admin@example.com")
+```
+
+The rodauth-rails gem additionally updates the internal rack env hash with your
+`config.action_mailer.default_url_options`, which is used for generating email
+links.
+
+For generating authentication URLs outside of a request use the
+[path_class_methods] plugin:
+
+```rb
+# app/lib/rodauth_app.rb
+class RodauthApp < Rodauth::Rails::App
+  configure do
+    enable :path_class_methods
+  end
+end
+```
+```rb
+# main configuration
+RodauthApp.rodauth.create_account_path
+RodauthApp.rodauth.verify_account_url(key: "abc123")
+
+# secondary configuration
+RodauthApp.rodauth(:admin).close_account_path
+```
+
+#### Calling instance methods
 
 If you need to access Rodauth methods not exposed as internal requests, you can
 use `Rodauth::Rails.rodauth` to retrieve the Rodauth instance used by the
@@ -810,19 +865,12 @@ In addition to the `:account` option, the `Rodauth::Rails.rodauth`
 method accepts any options supported by the internal_request feature.
 
 ```rb
-Rodauth::Rails.rodauth(
-  env: { "HTTP_USER_AGENT" => "programmatic" },
-  session: { two_factor_auth_setup: true },
-  params: { "param" => "value" },
-  # ...
-)
-```
+# main configuration
+Rodauth::Rails.rodauth(env: { "HTTP_USER_AGENT" => "programmatic" })
+Rodauth::Rails.rodauth(session: { two_factor_auth_setup: true })
 
-Secondary Rodauth configurations are specified by passing the configuration
-name:
-
-```rb
-Rodauth::Rails.rodauth(:admin)
+# secondary configuration
+Rodauth::Rails.rodauth(:admin, params: { "param" => "value" })
 ```
 
 ## How it works
@@ -1107,6 +1155,7 @@ methods:
 | `rails_check_csrf!`         | Verifies the authenticity token for the current request.           |
 | `rails_controller_instance` | Instance of the controller with the request env context.           |
 | `rails_controller`          | Controller class to use for rendering and CSRF protection.         |
+| `rails_account_model`       | Model class connected with the accounts table.                     |
 
 The `Rodauth::Rails` module has a few config settings available as well:
 
@@ -1423,3 +1472,5 @@ conduct](https://github.com/janko/rodauth-rails/blob/master/CODE_OF_CONDUCT.md).
 [account_expiration]: http://rodauth.jeremyevans.net/rdoc/files/doc/account_expiration_rdoc.html
 [simple_ldap_authenticator]: https://github.com/jeremyevans/simple_ldap_authenticator
 [internal_request]: http://rodauth.jeremyevans.net/rdoc/files/doc/internal_request_rdoc.html
+[composite_primary_keys]: https://github.com/composite-primary-keys/composite_primary_keys
+[path_class_methods]: https://rodauth.jeremyevans.net/rdoc/files/doc/path_class_methods_rdoc.html

data/lib/generators/rodauth/templates/app/lib/rodauth_app.rb

@@ -52,7 +52,7 @@ class RodauthApp < Rodauth::Rails::App
     # reset_password_autologin? true
 
     # Delete the account record when the user has closed their account.
-    # delete_account_on_close? true
+    delete_account_on_close? true
 
     # Redirect to the app from login and registration pages if already logged in.
     # already_logged_in { redirect login_redirect }

data/lib/rodauth/rails/controller_methods.rb

@@ -13,8 +13,7 @@ module Rodauth
       end
 
       def current_account(name = nil)
-        table = rodauth(name).accounts_table
-        model = table.to_s.classify.constantize
+        model = rodauth(name).rails_account_model
         id = rodauth(name).session_value
 
         @current_account ||= {}

data/lib/rodauth/rails/feature/base.rb

@@ -4,6 +4,7 @@ module Rodauth
       module Base
         def self.included(feature)
           feature.auth_methods :rails_controller
+          feature.auth_value_methods :rails_account_model
           feature.auth_cached_method :rails_controller_instance
         end
 
@@ -30,6 +31,14 @@ module Rodauth
           end
         end
 
+        def rails_account_model
+          table = accounts_table
+          table = table.column if table.is_a?(Sequel::SQL::QualifiedIdentifier) # schema is specified
+          table.to_s.classify.constantize
+        rescue NameError
+          raise Error, "cannot infer account model, please set `rails_account_model` in your rodauth configuration"
+        end
+
         delegate :rails_routes, :rails_request, to: :scope
 
         private

data/lib/rodauth/rails/model.rb

@@ -77,7 +77,7 @@ module Rodauth
         model.public_send type, name, scope,
           class_name: associated_model.name,
           foreign_key: foreign_key,
-          dependent: :destroy,
+          dependent: type == :has_many ? :delete_all : :delete,
           inverse_of: :account,
           **options,
           **association_options(name)

data/lib/rodauth/rails/version.rb

@@ -1,5 +1,5 @@
 module Rodauth
   module Rails
-    VERSION = "0.16.0"
+    VERSION = "0.17.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-rails
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-26 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties