rodauth-rails 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f888ea5284cc8afd796f548deec8741f63a474169f419d3f0479cf08bec6fe3b
-  data.tar.gz: 242e828939f8f96f15661b7f74adae54707ad0025431e46743f8be02879b4ffa
+  metadata.gz: 8d16d71f55347be4bf57f7081fda700bfb16c5a9e0007016f191607936e90315
+  data.tar.gz: 84febcfd24fca6166f6b5641c252a5c572a769a36535a5d2e2ab508fab6f60b3
 SHA512:
-  metadata.gz: d71684eb8b214f061fe589f70110a261bac980546c977834e37cceb53d56636714de08f123ac47d76feb7198814a7607174fafc8fb09be46a04cb9c2e4eb0c31
-  data.tar.gz: 129e9151b9002e5a58731b24f0d6dd28b20fcab313000d37efec19eb83c4d7d9e501c47dd224f46044318d9c610bab58041169f0adaf789467dc883afb71eb9a
+  metadata.gz: 5e01bbfdcba15b5e496dc314b4a249e270564f9d05183f55a16b4b500572fe13b39d15496ef7e6f97e4bb6cd3f88357408ddc140797f92c7c30d8b1a794e6e14
+  data.tar.gz: 8c09107331b002024ec55be77b604b9afdc957107d97ddb2aaa9f27146d3f338ae8817bce099be984bc536b2f0acdfa8cee14b0f86ed6997e86344ca28d0cd41

data/README.md

@@ -126,18 +126,18 @@ $ rails rodauth:routes
 ```
 Routes handled by RodauthApp:
 
-  GET|POST  /login                   rodauth.login_path
-  GET|POST  /create-account          rodauth.create_account_path
-  GET|POST  /verify-account-resend   rodauth.verify_account_resend_path
-  GET|POST  /verify-account          rodauth.verify_account_path
-  GET|POST  /change-password         rodauth.change_password_path
-  GET|POST  /change-login            rodauth.change_login_path
-  GET|POST  /logout                  rodauth.logout_path
-  GET|POST  /remember                rodauth.remember_path
-  GET|POST  /reset-password-request  rodauth.reset_password_request_path
-  GET|POST  /reset-password          rodauth.reset_password_path
-  GET|POST  /verify-login-change     rodauth.verify_login_change_path
-  GET|POST  /close-account           rodauth.close_account_path
+                   login  GET|POST  /login                   rodauth.login_path
+          create_account  GET|POST  /create-account          rodauth.create_account_path
+   verify_account_resend  GET|POST  /verify-account-resend   rodauth.verify_account_resend_path
+          verify_account  GET|POST  /verify-account          rodauth.verify_account_path
+         change_password  GET|POST  /change-password         rodauth.change_password_path
+            change_login  GET|POST  /change-login            rodauth.change_login_path
+                  logout  GET|POST  /logout                  rodauth.logout_path
+                remember  GET|POST  /remember                rodauth.remember_path
+  reset_password_request  GET|POST  /reset-password-request  rodauth.reset_password_request_path
+          reset_password  GET|POST  /reset-password          rodauth.reset_password_path
+     verify_login_change  GET|POST  /verify-login-change     rodauth.verify_login_change_path
+           close_account  GET|POST  /close-account           rodauth.close_account_path
 ```
 
 Using this information, you can add some basic authentication links to your
@@ -316,10 +316,28 @@ integration:
 $ rails generate rodauth:mailer
 ```
 
-This will create a `RodauthMailer`, email templates, and necessary Rodauth
-configuration for the features you have enabled. For email links to work, you
-need to have `config.action_mailer.default_url_options` set for each
-environment.
+This will create a `RodauthMailer` along with email templates, as well as output
+the necessary configuration that you should copy into your auth class:
+
+```rb
+# app/misc/rodauth_main.rb
+class RodauthMain < Rodauth::Rails::Auth
+  configure do
+    create_verify_account_email do
+      RodauthMailer.verify_account(self.class.configuration_name, account_id, verify_account_key_value)
+    end
+    create_reset_password_email do
+      RodauthMailer.reset_password(self.class.configuration_name, account_id, reset_password_key_value)
+    end
+    create_verify_login_change_email do |_login|
+      RodauthMailer.verify_login_change(self.class.configuration_name, account_id, verify_login_change_key_value)
+    end
+  end
+end
+```
+
+For email links to work, you need to have
+`config.action_mailer.default_url_options` set for each environment.
 
 ```rb
 # config/environments/development.rb
@@ -649,6 +667,7 @@ You can choose to insert the Rodauth middleware somewhere earlier than
 in front of the Rails router:
 
 ```rb
+# config/initializers/rodauth.rb
 Rodauth::Rails.configure do |config|
   config.middleware = false # disable auto-insertion
 end
@@ -656,6 +675,17 @@ end
 Rails.configuration.middleware.insert_before AnotherMiddleware, Rodauth::Rails::Middleware
 ```
 
+### Skipping Tilt
+
+Rodauth uses the [Tilt] gem to render built-in view & email templates. If you don't want to have Tilt as a dependency, you can disable it, provided that you've imported all view & email templates into your app:
+
+```rb
+# config/initializers/rodauth.rb
+Rodauth::Rails.configure do |config|
+  config.tilt = false # skip loading Tilt gem
+end
+```
+
 ## How it works
 
 ### Rack middleware
@@ -799,3 +829,4 @@ conduct](CODE_OF_CONDUCT.md).
 [library]: https://github.com/jeremyevans/rodauth#label-Using+Rodauth+as+a+Library
 [restoring defaults]: https://github.com/janko/rodauth-rails/wiki/Restoring-Rodauth-Defaults
 [Rack::Attack]: https://github.com/rack/rack-attack
+[Tilt]: https://github.com/jeremyevans/tilt

data/lib/generators/rodauth/install_generator.rb

@@ -40,18 +40,18 @@ module Rodauth
 
         def add_gems
           if activerecord? && !sequel?
-            gem "sequel-activerecord_connection", "~> 2.0", comment: "Enables Sequel to use Active Record's database connection"
-            gem "after_commit_everywhere", "~> 1.1", comment: "Required for Sequel's transaction hooks to work in all cases (on Active Record < 7.2)" if ActiveRecord.version < Gem::Version.new("7.2")
+            gem "sequel-activerecord_connection", "~> 2.0", require: false, comment: "Enables Sequel to use Active Record's database connection"
+            gem "after_commit_everywhere", "~> 1.1", require: false, comment: "Required for Sequel's transaction hooks to work in all cases (on Active Record < 7.2)" if ActiveRecord.version < Gem::Version.new("7.2")
           end
           if argon2?
-            gem "argon2", "~> 2.3", comment: "Used by Rodauth for password hashing"
+            gem "argon2", "~> 2.3", require: false, comment: "Used by Rodauth for password hashing"
           else
-            gem "bcrypt", "~> 3.1", comment: "Used by Rodauth for password hashing"
+            gem "bcrypt", "~> 3.1", require: false, comment: "Used by Rodauth for password hashing"
           end
           if jwt?
-            gem "jwt", "~> 2.9", comment: "Used by Rodauth for JWT support"
+            gem "jwt", "~> 2.9", require: false, comment: "Used by Rodauth for JWT support"
           end
-          gem "tilt", "~> 2.4", comment: "Used by Rodauth for rendering built-in view and email templates"
+          gem "tilt", "~> 2.4", require: false, comment: "Used by Rodauth for rendering built-in view and email templates"
         end
 
         def create_rodauth_controller

data/lib/generators/rodauth/templates/config/initializers/rodauth.rb.tt

@@ -1,3 +1,5 @@
 Rodauth::Rails.configure do |config|
   config.app = "RodauthApp"
+  # config.middleware = false # disable auto-insertion of Rodauth middleware
+  # config.tilt = false # skip loading Tilt gem for rendering built-in templates
 end

data/lib/rodauth/rails/app.rb

@@ -9,7 +9,7 @@ module Rodauth
       plugin :hooks
       plugin :pass
 
-      def self.configure(*args, **options, &block)
+      def self.configure(*args, render: Rodauth::Rails.tilt?, **options, &block)
         auth_class = args.shift if args[0].is_a?(Class)
         auth_class ||= Class.new(Rodauth::Rails::Auth)
         name = args.shift if args[0].is_a?(Symbol)
@@ -17,9 +17,9 @@ module Rodauth
         fail ArgumentError, "need to pass optional Rodauth::Auth subclass and optional configuration name" if args.any?
 
         # we'll render Rodauth's built-in view templates within Rails layouts
-        plugin :render, layout: false unless options[:render] == false
+        plugin :render, layout: false unless render == false
 
-        plugin :rodauth, auth_class: auth_class, name: name, csrf: false, flash: false, json: true, **options, &block
+        plugin :rodauth, auth_class: auth_class, name: name, csrf: false, flash: false, json: true, render: render, **options, &block
 
         # we need to do it after request methods from rodauth have been included
         self::RodaRequest.include RequestMethods

data/lib/rodauth/rails/tasks/routes.rb

@@ -18,6 +18,7 @@ module Rodauth
             verbs = route_verbs(route_name)
 
             [
+              route_name.to_s,
               verbs.join("|"),
               "#{rodauth.prefix}#{path}",
               "rodauth#{configuration_name && "(:#{configuration_name})"}.#{route_name}_path",
@@ -28,7 +29,7 @@ module Rodauth
           padding = routes.transpose.map { |string| string.map(&:length).max }
 
           output_lines = routes.map do |columns|
-            [columns[0].ljust(padding[0]), columns[1].ljust(padding[1]), columns[2]].join("  ")
+            [columns[0].rjust(padding[0]), columns[1].ljust(padding[1]), columns[2].ljust(padding[2]), columns[3]].join("  ")
           end
 
           puts "\n  #{output_lines.join("\n  ")}"
@@ -67,4 +68,3 @@ module Rodauth
     end
   end
 end
-

data/lib/rodauth/rails/version.rb

@@ -1,5 +1,5 @@
 module Rodauth
   module Rails
-    VERSION = "2.0.2"
+    VERSION = "2.1.0"
   end
 end

data/lib/rodauth/rails.rb

@@ -14,6 +14,7 @@ module Rodauth
 
     @app = nil
     @middleware = true
+    @tilt = true
 
     class << self
       def lib(**options, &block)
@@ -82,6 +83,7 @@ module Rodauth
 
       attr_writer :app
       attr_writer :middleware
+      attr_writer :tilt
 
       def app
         fail Rodauth::Rails::Error, "app was not configured" unless @app
@@ -92,6 +94,10 @@ module Rodauth
       def middleware?
         @middleware
       end
+
+      def tilt?
+        @tilt
+      end
     end
   end
 end

data/rodauth-rails.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.files         = Dir["README.md", "LICENSE.txt", "lib/**/*", "*.gemspec"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "railties", ">= 5.0", "< 8.1"
+  spec.add_dependency "railties", ">= 5.1", "< 8.1"
   spec.add_dependency "rodauth", "~> 2.36"
   spec.add_dependency "roda", "~> 3.76"
   spec.add_dependency "rodauth-model", "~> 0.2"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Janko Marohnić
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.1'
@@ -26,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.1'
@@ -350,7 +349,6 @@ homepage: https://github.com/janko/rodauth-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -365,8 +363,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Provides Rails integration for Rodauth authentication framework.
 test_files: []