rodauth 2.44.0 → 2.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 040bf69b63cc893df29a1a4e5c99889f5dc7fcae928c81639be5a38157dc910e
-  data.tar.gz: 0f013ee9f86f80379fe575251697fc622f9c0d9ede248e39df67565312edc6eb
+  metadata.gz: 5dea248f50448b260c6d0007d8bc4054f17794270e857a6310b969ba58105fbf
+  data.tar.gz: 875dbda4ddd85b04041a8e854e0adb09b466269ecef74dd1a73f384519d54553
 SHA512:
-  metadata.gz: a9d5ec9033e65cd7578dad8864eb5fcfb258f7ba4484e949923a3502e2e642a77898a01fa2dbb0947d92c4ce009e9b238d5e11a7243cf7f25ad566e9c38c6d72
-  data.tar.gz: 2fb3aafcb91f26560370059512bb074122bb87267c7d50c27aa465a2ede5b0380dec0d0d17cb946121ca83a28716ffad02427bc83ae9c4959c44f5bc82a21bb9
+  metadata.gz: dbf7c82f8b1c93496c59225891c1d747f317eaf46d8283f9c6f2d0562a48aaaec4d6491ed7567011356914fb4498e0f86576c230e183cf53c0ac7a7c5f27d99a
+  data.tar.gz: c8c2a228ce0395e4e14dbd1a69b01f7038b2ac94267b33bc5695d11b3eae6a278846be5100714dc18b0a65010db1693c0621f9ec1f2d0ba0793e92b61a698bf9

data/lib/rodauth/features/base.rb

@@ -35,7 +35,7 @@ module Rodauth
     auth_value_method :accounts_table, :accounts
     auth_value_method :cache_templates, true
     auth_value_method :check_csrf_block, nil
-    auth_value_method :check_csrf_opts, {}.freeze
+    auth_value_method :check_csrf_opts, OPTS
     auth_value_method :default_redirect, '/'
     auth_value_method :convert_token_id_to_integer?, nil
     flash_key :flash_error_key, :error
@@ -73,9 +73,10 @@ module Rodauth
     auth_value_method :mark_input_fields_with_inputmode?, true
     auth_value_method :skip_status_checks?, true
     translatable_method :strftime_format, '%F %T'
-    auth_value_method :template_opts, {}.freeze
+    auth_value_method :template_opts, OPTS
     auth_value_method :title_instance_variable, nil 
     auth_value_method :token_separator, "_"
+    auth_value_method :transaction_opts, OPTS
     auth_value_method :unmatched_field_error_status, 422
     auth_value_method :unopen_account_error_status, 403
     translatable_method :unverified_account_message, "unverified account, please verify account before logging in"
@@ -107,6 +108,7 @@ module Rodauth
       :check_csrf,
       :clear_session,
       :clear_tokens,
+      :convert_token_id,
       :csrf_tag,
       :function_name,
       :hook_action,
@@ -135,7 +137,6 @@ module Rodauth
       :account_from_id,
       :account_from_login,
       :account_from_session,
-      :convert_token_id,
       :field_attributes,
       :field_error_attributes,
       :formatted_field_error,
@@ -218,7 +219,7 @@ module Rodauth
       end
     end
 
-    def input_field_string(param, id, opts={})
+    def input_field_string(param, id, opts=OPTS)
       type = opts.fetch(:type, "text")
 
       unless type == "password"
@@ -449,7 +450,7 @@ module Rodauth
       _template_opts(opts, 'button')
     end
 
-    def button(value, opts={})
+    def button(value, opts=OPTS)
       scope.render(button_opts(value, opts))
     end
 
@@ -696,17 +697,18 @@ module Rodauth
       request.halt
     end
 
-    def route_path(route, opts={})
+    def route_path(route, opts=OPTS)
       path  = "#{prefix}/#{route}"
       path += "?#{Rack::Utils.build_nested_query(opts)}" unless opts.empty?
       path
     end
 
-    def route_url(route, opts={})
+    def route_url(route, opts=OPTS)
       "#{base_url}#{route_path(route, opts)}"
     end
 
-    def transaction(opts={}, &block)
+    def transaction(opts=OPTS, &block)
+      opts = opts.empty? ? transaction_opts : transaction_opts.merge(opts)
       db.transaction(opts, &block)
     end
 
@@ -966,6 +968,14 @@ module Rodauth
       false
     end
 
+    # :nocov:
+    if RUBY_VERSION >= '4.0'
+    # :nocov:
+      def instance_variables_to_inspect
+        instance_variables.reject{|v| instance_variable_get(v).nil?}
+      end
+    end
+
     def use_scope_clear_session?
       scope.respond_to?(:clear_session)
     end

data/lib/rodauth/features/internal_request.rb

@@ -318,7 +318,7 @@ module Rodauth
       ]
     end
 
-    def internal_request(route, opts={}, &block)
+    def internal_request(route, opts=OPTS, &block)
       opts = opts.dup
       
       env = {
@@ -425,7 +425,7 @@ module Rodauth
         feature = FEATURES[feature_name]
         if meths = feature.internal_request_methods
           meths.each do |name|
-            klass.define_singleton_method(name){|opts={}, &block| internal_class.internal_request(name, opts, &block)}
+            klass.define_singleton_method(name){|opts=OPTS, &block| internal_class.internal_request(name, opts, &block)}
           end
         end
       end

data/lib/rodauth/features/json.rb

@@ -2,6 +2,8 @@
 
 module Rodauth
   Feature.define(:json, :Json) do
+    self.allowed_undefined_configuration_methods = [:only_json?].freeze
+
     translatable_method :json_not_accepted_error_message, 'Unsupported Accept header. Must accept "application/json" or compatible content type'
     translatable_method :json_non_post_error_message, 'non-POST method used in JSON API'
     auth_value_method :json_accept_regexp, /(?:(?:\*|\bapplication)\/\*|\bapplication\/(?:vnd\.api\+)?json\b)/i

data/lib/rodauth/features/jwt.rb

@@ -11,7 +11,7 @@ module Rodauth
     auth_value_method :jwt_algorithm, "HS256"
     auth_value_method :jwt_authorization_ignore, /\A(?:Basic|Digest) /
     auth_value_method :jwt_authorization_remove, /\ABearer:?\s+/
-    auth_value_method :jwt_decode_opts, {}.freeze
+    auth_value_method :jwt_decode_opts, OPTS
     auth_value_method :jwt_old_secret, nil
     auth_value_method :jwt_session_key, nil
     auth_value_method :jwt_symbolize_deeply?, false

data/lib/rodauth/features/lockout.rb

@@ -251,7 +251,14 @@ module Rodauth
 
     private
 
-    attr_reader :unlock_account_key_value
+    def unlock_account_key
+      @unlock_account_key_value
+    end
+
+    def unlock_account_key_value
+      # RODAUTH3: call unlock_account_key directly
+      unlock_account_key
+    end
 
     def before_login_attempt
       if locked_out?

data/lib/rodauth/features/path_class_methods.rb

@@ -13,8 +13,8 @@ module Rodauth
           path_meth = :"#{route}_path"
           url_meth = :"#{route}_url"
           instance = klass.allocate.freeze
-          klass.define_singleton_method(path_meth){|opts={}| instance.send(path_meth, opts)}
-          klass.define_singleton_method(url_meth){|opts={}| instance.send(url_meth, opts)}
+          klass.define_singleton_method(path_meth){|opts=OPTS| instance.send(path_meth, opts)}
+          klass.define_singleton_method(url_meth){|opts=OPTS| instance.send(url_meth, opts)}
         end
       end
     end

data/lib/rodauth/features/remember.rb

@@ -16,7 +16,7 @@ module Rodauth
     response
 
     auth_value_method :raw_remember_token_deadline, nil
-    auth_value_method :remember_cookie_options, {}.freeze
+    auth_value_method :remember_cookie_options, OPTS
     auth_value_method :extend_remember_deadline?, false
     auth_value_method :extend_remember_deadline_period, 3600
     auth_value_method :remember_period, {:days=>14}.freeze

data/lib/rodauth/features/reset_password.rb

@@ -192,6 +192,11 @@ module Rodauth
     end
 
     def get_password_reset_key(id)
+      # RODAUTH3: Remove method and call get_reset_password_key directly
+      get_reset_password_key(id)
+    end
+
+    def get_reset_password_key(id)
       ds = password_reset_ds(id)
       ds.where(Sequel::CURRENT_TIMESTAMP > reset_password_deadline_column).delete
       ds.get(reset_password_key_column)

data/lib/rodauth/features/sms_codes.rb

@@ -92,7 +92,6 @@ module Rodauth
     auth_value_methods(
       :sms_codes_primary?,
       :sms_needs_confirmation_notice_flash,
-      :sms_request_response
     )
 
     auth_methods(
@@ -120,6 +119,7 @@ module Rodauth
       :sms_setup?,
       :sms_valid_phone?
     )
+    auth_private_methods :sms_request_response
 
     uses_instance_variables(:@sms)
 

data/lib/rodauth/version.rb

@@ -6,7 +6,7 @@ module Rodauth
   MAJOR = 2
 
   # The minor version of Rodauth, updated for new feature releases of Rodauth.
-  MINOR = 44
+  MINOR = 45
 
   # The patch version of Rodauth, updated only for bug fixes from the last
   # feature release.

data/lib/rodauth.rb

@@ -3,9 +3,12 @@
 require 'securerandom'
 
 module Rodauth
+  OPTS = {}.freeze
+  SCOPE_INSTANCE_VARIABLES = [:@_rodauths, :@_rodauth].freeze
+
   class ConfigurationError < StandardError; end
 
-  def self.lib(opts={}, &block) 
+  def self.lib(opts=OPTS, &block) 
     require 'roda'
     c = Class.new(Roda)
     c.plugin(:rodauth, opts) do
@@ -16,7 +19,7 @@ module Rodauth
     c.rodauth
   end
 
-  def self.load_dependencies(app, opts={}, &_)
+  def self.load_dependencies(app, opts=OPTS, &_)
     json_opt = opts.fetch(:json, app.opts[:rodauth_json])
     if json_opt
       app.plugin :json
@@ -45,7 +48,7 @@ module Rodauth
     end
   end
 
-  def self.configure(app, opts={}, &block)
+  def self.configure(app, opts=OPTS, &block)
     json_opt = app.opts[:rodauth_json] = opts.fetch(:json, app.opts[:rodauth_json])
     csrf = app.opts[:rodauth_csrf] = opts.fetch(:csrf, app.opts[:rodauth_csrf])
     app.opts[:rodauth_route_csrf] = case csrf
@@ -71,15 +74,32 @@ module Rodauth
 
   class FeatureConfiguration < Module
     def def_configuration_methods(feature)
-      private_methods = feature.private_instance_methods.map(&:to_sym)
+      private_methods = feature.private_instance_methods
       priv = proc{|m| private_methods.include?(m)}
-      feature.auth_methods.each{|m| def_auth_method(m, priv[m])}
-      feature.auth_value_methods.each{|m| def_auth_value_method(m, priv[m])}
-      feature.auth_private_methods.each{|m| def_auth_private_method(m)}
+      feature.auth_methods.each do |m|
+        _check_method_defined(feature, m, priv[m])
+        def_auth_method(m, priv[m])
+      end
+      feature.auth_value_methods.each do |m|
+        _check_method_defined(feature, m, priv[m])
+        def_auth_value_method(m, priv[m])
+      end
+      feature.auth_private_methods.each do |m|
+        _check_method_defined(feature, :"_#{m}", true)
+        def_auth_private_method(m)
+      end
     end
 
     private
 
+    def _check_method_defined(feature, meth, priv)
+      if !feature.send(priv ? :private_method_defined? : :method_defined?, meth) &&
+          (!(allowed = feature.allowed_undefined_configuration_methods) || !allowed.include?(meth))
+        # RODAUTH3: raise instead of warn
+        warn "Bug in Rodauth #{feature.feature_name} feature definition, configuration method added for #{meth}, but the feature doesn't define the method"
+      end
+    end
+
     def def_auth_method(meth, priv)
       define_method(meth) do |&block|
         @auth.send(:define_method, meth, &block)
@@ -125,6 +145,7 @@ module Rodauth
     attr_accessor :dependencies
     attr_accessor :routes
     attr_accessor :configuration
+    attr_accessor :allowed_undefined_configuration_methods
     attr_reader :internal_request_methods
     attr_reader :instance_variables_used
 
@@ -132,8 +153,8 @@ module Rodauth
       route_meth = :"#{name}_route"
       auth_value_method route_meth, default
 
-      define_method(:"#{name}_path"){|opts={}| route_path(send(route_meth), opts) if send(route_meth)}
-      define_method(:"#{name}_url"){|opts={}| route_url(send(route_meth), opts) if send(route_meth)}
+      define_method(:"#{name}_path"){|opts=OPTS| route_path(send(route_meth), opts) if send(route_meth)}
+      define_method(:"#{name}_url"){|opts=OPTS| route_url(send(route_meth), opts) if send(route_meth)}
 
       handle_meth = :"handle_#{name}"
       internal_handle_meth = :"_#{handle_meth}"
@@ -260,7 +281,7 @@ module Rodauth
       end
     end
 
-    def email(type, subject, opts = {})
+    def email(type, subject, opts = OPTS)
       subject_method = :"#{type}_email_subject"
       body_method = :"#{type}_email_body"
       create_method = :"create_#{type}_email"
@@ -507,7 +528,7 @@ module Rodauth
       view_opts = rodauth.send(:loaded_templates).map do |page|
         rodauth.send(:_view_opts, page)
       end
-      view_opts << rodauth.send(:button_opts, '', {})
+      view_opts << rodauth.send(:button_opts, '', OPTS)
 
       view_opts.each do |opts|
         instance.send(:retrieve_template, opts).send(:compiled_method, opts[:locals].keys.sort_by(&:to_s))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rodauth
 version: !ruby/object:Gem::Version
-  version: 2.44.0
+  version: 2.45.0
 platform: ruby
 authors:
 - Jeremy Evans