rodauth-tools 0.3.0

data/lib/rodauth/template_inspector.rb

@@ -0,0 +1,134 @@
+# lib/rodauth/template_inspector.rb
+#
+# frozen_string_literal: true
+
+require 'erb'
+require 'dry/inflector'
+
+module Rodauth
+  # Inspects ERB templates to extract table information
+  #
+  # This module solves the "hidden tables" problem where ERB templates create
+  # tables that don't have corresponding *_table methods in Rodauth features.
+  # For example, base.erb creates account_statuses and account_password_hashes
+  # tables, but only accounts_table method exists.
+  #
+  # By evaluating ERB templates, we can discover ALL tables that will be created,
+  # which is essential for generating complete DROP statements.
+  module TemplateInspector
+    # Extract table names from a single ERB template
+    #
+    # @param feature [Symbol] Feature name (e.g., :base, :verify_account)
+    # @param table_prefix [String] Table prefix to use (default: 'account')
+    # @param db_type [Symbol] Database type for conditional logic (default: :postgres)
+    # @return [Array<Symbol>] Array of table names that will be created
+    def self.extract_tables_from_template(feature, table_prefix: 'account', db_type: :postgres)
+      template_path = template_path_for_feature(feature)
+      return [] unless File.exist?(template_path)
+
+      template_content = File.read(template_path)
+
+      # Create binding context with necessary methods
+      context = BindingContext.new(table_prefix, db_type)
+
+      # Evaluate ERB template
+      begin
+        rendered = ERB.new(template_content, trim_mode: '-').result(context.get_binding)
+      rescue StandardError => e
+        warn "Failed to evaluate template for #{feature}: #{e.message}"
+        return []
+      end
+
+      # Extract table names from create_table calls
+      # Matches: create_table(:table_name) or create_table?(:table_name)
+      tables = rendered.scan(/create_table\??[:(\s]+:?(\w+)/).flatten
+
+      tables.map(&:to_sym).uniq
+    end
+
+    # Get all tables for a set of features
+    #
+    # @param features [Array<Symbol>] Feature names
+    # @param table_prefix [String] Table prefix to use
+    # @param db_type [Symbol] Database type
+    # @return [Array<Symbol>] Array of all table names across features
+    def self.all_tables_for_features(features, table_prefix: 'account', db_type: :postgres)
+      tables = []
+
+      features.each do |feature|
+        feature_tables = extract_tables_from_template(
+          feature,
+          table_prefix: table_prefix,
+          db_type: db_type
+        )
+        tables.concat(feature_tables)
+      end
+
+      tables.uniq
+    end
+
+    # Get template path for a feature
+    #
+    # @param feature [Symbol] Feature name
+    # @return [String] Absolute path to ERB template
+    def self.template_path_for_feature(feature)
+      File.join(__dir__, 'tools', 'migration', 'sequel', "#{feature}.erb")
+    end
+
+    # Binding context for ERB evaluation
+    #
+    # Provides minimal methods needed for ERB template evaluation without
+    # requiring a full database connection or Rodauth instance.
+    class BindingContext
+      attr_reader :table_prefix
+
+      def initialize(table_prefix, db_type)
+        @table_prefix = table_prefix
+        @db_type = db_type
+        @inflector = Dry::Inflector.new
+      end
+
+      # Pluralize a word using dry-inflector
+      def pluralize(word)
+        @inflector.pluralize(word.to_s)
+      end
+
+      # Mock database object for template evaluation
+      #
+      # Templates check db.database_type and db.supports_partial_indexes?
+      # to generate database-specific code.
+      def db
+        @db ||= MockDatabase.new(@db_type)
+      end
+
+      # Get binding for ERB evaluation
+      def get_binding
+        binding
+      end
+
+      # Mock Sequel database for ERB templates
+      class MockDatabase
+        attr_reader :database_type
+
+        def initialize(db_type)
+          @database_type = db_type
+        end
+
+        def supports_partial_indexes?
+          # PostgreSQL and SQLite support partial indexes
+          %i[postgres sqlite].include?(@database_type)
+        end
+
+        # Stub other methods that might be called in templates
+        def method_missing(_method, *_args)
+          # Return a safe default for unknown methods
+          nil
+        end
+
+        def respond_to_missing?(_method, _include_private = false)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rodauth/tools/console_helpers.rb

@@ -0,0 +1,158 @@
+# lib/rodauth/tools/console_helpers.rb
+#
+# frozen_string_literal: true
+
+module Rodauth
+  module Tools
+    # Console helper methods for inspecting Rodauth table configuration
+    #
+    # Usage in console:
+    #   require 'rodauth/tools/console_helpers'
+    #   include Rodauth::Tools::ConsoleHelpers
+    #   rodauth.table_configuration
+    #
+    # Or use the convenience loader:
+    #   Rodauth::Tools::ConsoleHelpers.load!(rodauth_instance)
+    module ConsoleHelpers
+      # Get or create a Rodauth instance
+      #
+      # Override this method in your console script to provide the actual instance
+      def rodauth
+        @rodauth ||= raise NotImplementedError, 'You must define a `rodauth` method that returns a Rodauth instance'
+      end
+
+      # Get discovered table configuration
+      def config
+        rodauth.table_configuration
+      end
+
+      # Get missing tables
+      def missing
+        rodauth.missing_tables
+      end
+
+      # List all required table names
+      def tables
+        rodauth.list_all_required_tables
+      end
+
+      # Get detailed status for each table
+      def status
+        rodauth.table_status
+      end
+
+      # Access database connection
+      def db
+        rodauth.db if rodauth.respond_to?(:db)
+      end
+
+      # Pretty-print table configuration
+      def show_config
+        puts "\n=== Table Configuration ==="
+        config.each do |method, info|
+          puts "\n#{method}:"
+          puts "  Table: #{info[:name]}"
+          puts "  Feature: #{info[:feature]}"
+          puts "  Type: #{info[:structure][:type]}"
+          puts "  Exists: #{rodauth.table_exists?(info[:name])}"
+        end
+        nil
+      end
+
+      # Pretty-print missing tables
+      def show_missing
+        puts "\n=== Missing Tables ==="
+        if missing.empty?
+          puts '✓ All tables exist!'
+        else
+          missing.each do |info|
+            puts "✗ #{info[:table]} (feature: #{info[:feature]})"
+          end
+        end
+        nil
+      end
+
+      # Pretty-print table status
+      def show_status
+        puts "\n=== Table Status ==="
+        status.each do |info|
+          marker = info[:exists] ? '✓' : '✗'
+          puts "#{marker} #{info[:table].to_s.ljust(30)} (#{info[:feature]})"
+        end
+        nil
+      end
+
+      # Create missing tables immediately
+      def create_tables!
+        puts "\n=== Creating Missing Tables ==="
+        missing_list = missing
+        if missing_list.empty?
+          puts '✓ All tables already exist!'
+          return
+        end
+
+        generator = Rodauth::SequelGenerator.new(missing_list, rodauth)
+        generator.execute_creates(db)
+        puts "✓ Created #{missing_list.size} table(s)"
+        show_status
+        nil
+      end
+
+      # Display generated migration code
+      def show_migration
+        puts "\n=== Generated Migration ==="
+        missing_list = missing
+        if missing_list.empty?
+          puts '✓ All tables exist - no migration needed'
+          return
+        end
+
+        generator = Rodauth::SequelGenerator.new(missing_list, rodauth)
+        puts generator.generate_migration
+        nil
+      end
+
+      # Show help message
+      def help
+        puts <<~HELP
+
+          🔍 Rodauth Console Helpers
+          ============================
+
+          rodauth          # Get Rodauth instance
+          config           # Get discovered table configuration
+          missing          # Get missing tables
+          tables           # List all required table names
+          status           # Get detailed status for each table
+          db               # Access Sequel database connection
+
+          show_config      # Pretty-print table configuration
+          show_missing     # Pretty-print missing tables
+          show_status      # Pretty-print table status
+          create_tables!   # Create all missing tables
+          show_migration   # Display generated migration code
+
+          help             # Show this help
+
+          Examples:
+          ---------
+          config.keys                         # See all table methods
+          missing.size                        # How many tables are missing?
+          rodauth.table_exists?(:accounts)    # Check specific table
+          db.tables                           # See what's in the database
+
+        HELP
+        nil
+      end
+
+      # Class method to extend a context with helpers and set up rodauth method
+      #
+      # @param rodauth_instance [Rodauth::Auth] Rodauth instance
+      # @return [Module] Extended module
+      def self.extended(base)
+        puts "\n✓ Rodauth console helpers loaded!"
+        base.help if base.respond_to?(:help)
+      end
+    end
+  end
+end

data/lib/rodauth/tools/migration/sequel/account_expiration.erb

@@ -0,0 +1,9 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the account expiration feature
+create_table(:<%= table_prefix %>_activity_times) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  DateTime :last_activity_at, null: false
+  DateTime :last_login_at, null: false
+  DateTime :expired_at
+end

data/lib/rodauth/tools/migration/sequel/active_sessions.erb

@@ -0,0 +1,10 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the active sessions feature
+create_table(:<%= table_prefix %>_active_session_keys) do
+  foreign_key :<%= table_prefix %>_id, :<%= pluralize(table_prefix) %>, type: :Bignum
+  String :session_id
+  Time :created_at, null: false, default: Sequel::CURRENT_TIMESTAMP
+  Time :last_use, null: false, default: Sequel::CURRENT_TIMESTAMP
+  primary_key [:<%= table_prefix %>_id, :session_id]
+end

data/lib/rodauth/tools/migration/sequel/audit_logging.erb

@@ -0,0 +1,12 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the audit logging feature
+create_table(:<%= table_prefix %>_authentication_audit_logs) do
+  primary_key :id, type: :Bignum
+  foreign_key :<%= table_prefix %>_id, :<%= pluralize(table_prefix) %>, null: false, type: :Bignum
+  DateTime :at, null: false, default: Sequel::CURRENT_TIMESTAMP
+  String :message, null: false
+  column :metadata, <%= json_type %>
+  index [:<%= table_prefix %>_id, :at], name: :audit_<%= table_prefix %>_at_idx
+  index :at, name: :audit_at_idx
+end

data/lib/rodauth/tools/migration/sequel/base.erb

@@ -0,0 +1,41 @@
+<%# lib/rodauth/tools/migration/sequel/base.erb %>
+
+db = self
+<% if db.database_type == :postgres -%>
+begin
+  run "CREATE EXTENSION IF NOT EXISTS citext"
+rescue NoMethodError # migration is being reverted
+end
+<% end -%>
+
+# Sequel extension
+extension :date_arithmetic
+
+# Used by the account verification and close account features
+create_table(:<%= table_prefix %>_statuses) do
+  Integer :id, primary_key: true
+  String :name, null: false, unique: true
+end
+from(:<%= table_prefix %>_statuses).import([:id, :name], [[1, 'Unverified'], [2, 'Verified'], [3, 'Closed']])
+
+create_table(:<%= table_prefix %>_password_hashes) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :password_hash, null: false
+end
+
+create_table(:<%= pluralize(table_prefix) %>) do
+  primary_key :id, type: :Bignum
+  foreign_key :status_id, :<%= table_prefix %>_statuses, null: false, default: 1
+<% if db.database_type == :postgres -%>
+  citext :email, null: false
+  constraint :valid_email, email: /^[^,;@ \r\n]+@[^,@; \r\n]+\.[^,@; \r\n]+$/
+<% else -%>
+  String :email, null: false
+<% end -%>
+<% if db.supports_partial_indexes? -%>
+  index :email, unique: true, where: {status_id: [1, 2]}
+<% else -%>
+  index :email, unique: true
+<% end -%>
+  String :password_hash, null: true
+end

data/lib/rodauth/tools/migration/sequel/disallow_password_reuse.erb

@@ -0,0 +1,8 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the disallow password reuse feature
+create_table(:<%= table_prefix %>_previous_password_hashes) do
+  primary_key :id, type: :Bignum
+  foreign_key :<%= table_prefix %>_id, :<%= pluralize(table_prefix) %>, type: :Bignum
+  String :password_hash, null: false
+end

data/lib/rodauth/tools/migration/sequel/email_auth.erb

@@ -0,0 +1,17 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the email auth feature
+deadline_opts = proc do |days|
+  if db.database_type == :mysql
+    {null: false}
+  else
+    {null: false, default: Sequel.date_add(Sequel::CURRENT_TIMESTAMP, days: days)}
+  end
+end
+
+create_table(:<%= table_prefix %>_email_auth_keys) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  DateTime :deadline, deadline_opts[1]
+  DateTime :email_last_sent, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/rodauth/tools/migration/sequel/jwt_refresh.erb

@@ -0,0 +1,18 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the jwt refresh feature
+deadline_opts = proc do |days|
+  if db.database_type == :mysql
+    {null: false}
+  else
+    {null: false, default: Sequel.date_add(Sequel::CURRENT_TIMESTAMP, days: days)}
+  end
+end
+
+create_table(:<%= table_prefix %>_jwt_refresh_keys) do
+  primary_key :id, type: :Bignum
+  foreign_key :<%= table_prefix %>_id, :<%= pluralize(table_prefix) %>, null: false, type: :Bignum
+  String :key, null: false
+  DateTime :deadline, deadline_opts[1]
+  index :<%= table_prefix %>_id, name: :<%= table_prefix %>_jwt_rk_<%= table_prefix %>_id_idx
+end

data/lib/rodauth/tools/migration/sequel/lockout.erb

@@ -0,0 +1,21 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the lockout feature
+deadline_opts = proc do |days|
+  if db.database_type == :mysql
+    {null: false}
+  else
+    {null: false, default: Sequel.date_add(Sequel::CURRENT_TIMESTAMP, days: days)}
+  end
+end
+
+create_table(:<%= table_prefix %>_login_failures) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  Integer :number, null: false, default: 1
+end
+create_table(:<%= table_prefix %>_lockouts) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  DateTime :deadline, deadline_opts[1]
+  DateTime :email_last_sent
+end

data/lib/rodauth/tools/migration/sequel/otp.erb

@@ -0,0 +1,9 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the otp feature
+create_table(:<%= table_prefix %>_otp_keys) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  Integer :num_failures, null: false, default: 0
+  Time :last_use, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/rodauth/tools/migration/sequel/otp_unlock.erb

@@ -0,0 +1,8 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the otp_unlock feature
+create_table(:<%= table_prefix %>_otp_unlocks) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  Integer :num_successes, null: false, default: 1
+  Time :next_auth_attempt_after, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/rodauth/tools/migration/sequel/password_expiration.erb

@@ -0,0 +1,7 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the password expiration feature
+create_table(:<%= table_prefix %>_password_change_times) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  DateTime :changed_at, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/rodauth/tools/migration/sequel/recovery_codes.erb

@@ -0,0 +1,8 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the recovery codes feature
+create_table(:<%= table_prefix %>_recovery_codes) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, type: :Bignum
+  String :code
+  primary_key [:id, :code]
+end

data/lib/rodauth/tools/migration/sequel/remember.erb

@@ -0,0 +1,16 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the remember me feature
+deadline_opts = proc do |days|
+  if db.database_type == :mysql
+    {null: false}
+  else
+    {null: false, default: Sequel.date_add(Sequel::CURRENT_TIMESTAMP, days: days)}
+  end
+end
+
+create_table(:<%= table_prefix %>_remember_keys) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  DateTime :deadline, deadline_opts[14]
+end

data/lib/rodauth/tools/migration/sequel/reset_password.erb

@@ -0,0 +1,17 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the password reset feature
+deadline_opts = proc do |days|
+  if db.database_type == :mysql
+    {null: false}
+  else
+    {null: false, default: Sequel.date_add(Sequel::CURRENT_TIMESTAMP, days: days)}
+  end
+end
+
+create_table(:<%= table_prefix %>_password_reset_keys) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  DateTime :deadline, deadline_opts[1]
+  DateTime :email_last_sent, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/rodauth/tools/migration/sequel/single_session.erb

@@ -0,0 +1,7 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the single session feature
+create_table(:<%= table_prefix %>_session_keys) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :key, null: false
+end

data/lib/rodauth/tools/migration/sequel/sms_codes.erb

@@ -0,0 +1,10 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the sms codes feature
+create_table(:<%= table_prefix %>_sms_codes) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :phone_number, null: false
+  Integer :num_failures
+  String :code
+  DateTime :code_issued_at, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/rodauth/tools/migration/sequel/verify_account.erb

@@ -0,0 +1,9 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the account verification feature
+create_table(:<%= table_prefix %>_verification_keys) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  DateTime :requested_at, null: false, default: Sequel::CURRENT_TIMESTAMP
+  DateTime :email_last_sent, null: false, default: Sequel::CURRENT_TIMESTAMP
+end

data/lib/rodauth/tools/migration/sequel/verify_login_change.erb

@@ -0,0 +1,17 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the verify login change feature
+deadline_opts = proc do |days|
+  if db.database_type == :mysql
+    {null: false}
+  else
+    {null: false, default: Sequel.date_add(Sequel::CURRENT_TIMESTAMP, days: days)}
+  end
+end
+
+create_table(:<%= table_prefix %>_login_change_keys) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :key, null: false
+  String :login, null: false
+  DateTime :deadline, deadline_opts[1]
+end

data/lib/rodauth/tools/migration/sequel/webauthn.erb

@@ -0,0 +1,15 @@
+<%# lib/rodauth/tools/migration/sequel/audit_logging.erb %>
+
+# Used by the webauthn feature
+create_table(:<%= table_prefix %>_webauthn_user_ids) do
+  foreign_key :id, :<%= pluralize(table_prefix) %>, primary_key: true, type: :Bignum
+  String :webauthn_id, null: false
+end
+create_table(:<%= table_prefix %>_webauthn_keys) do
+  foreign_key :<%= table_prefix %>_id, :<%= pluralize(table_prefix) %>, type: :Bignum
+  String :webauthn_id
+  String :public_key, null: false
+  Integer :sign_count, null: false
+  Time :last_use, null: false, default: Sequel::CURRENT_TIMESTAMP
+  primary_key [:<%= table_prefix %>_id, :webauthn_id]
+end