plutonium 0.13.3 → 0.14.1

data/lib/plutonium.rb

@@ -1,57 +1,71 @@
-require "zeitwerk"
-
-# Zeitwerk loader setup for the Plutonium gem
-loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
-loader.ignore("#{__dir__}/generators")
-loader.ignore("#{__dir__}/plutonium/railtie.rb")
-loader.enable_reloading if defined?(Rails.env) && Rails.env.development?
-loader.setup
+# frozen_string_literal: true
 
-require_relative "plutonium/railtie" if defined?(Rails::Railtie)
+require "zeitwerk"
+require_relative "plutonium/configuration"
 
+# Plutonium module
+#
+# This module provides the main functionality for the Plutonium gem.
+# It sets up autoloading using Zeitwerk and provides utility methods
+# for accessing gem-related information.
 module Plutonium
-  # Custom error class for the Plutonium module
+  # Custom error class for Plutonium-specific exceptions
   class Error < StandardError; end
 
+  # Set up Zeitwerk loader for the Plutonium gem
+  # @return [Zeitwerk::Loader] configured Zeitwerk loader instance
+  ZEITWERK_LOADER = Zeitwerk::Loader.for_gem(warn_on_extra_files: false).tap do |loader|
+    loader.ignore("#{__dir__}/generators")
+    loader.ignore("#{__dir__}/plutonium/railtie.rb")
+    loader.enable_reloading if defined?(Rails.env) && Rails.env.development?
+    loader.setup
+  end
+
   class << self
-    # @return [Pathname] the root directory of the gem
+    # Get the root directory of the gem
+    #
+    # @return [Pathname] the root directory path
     def root
-      Pathname.new(File.expand_path("..", __dir__))
+      @root ||= Pathname.new(File.expand_path("..", __dir__))
     end
 
-    # @return [Pathname] the root directory of the lib folder of the gem
+    # Get the root directory of the lib folder of the gem
+    #
+    # @return [Pathname] the lib root directory path
     def lib_root
-      root.join("lib", "plutonium")
+      @lib_root ||= root.join("lib", "plutonium")
     end
 
-    # @return [Logger] the Rails logger
+    # Get the Rails logger
+    #
+    # @return [Logger] the Rails logger instance
     def logger
       Rails.logger
     end
 
-    # @return [String] the name of the application
+    # Get the name of the application
+    #
+    # @return [String] the application name
     def application_name
       @application_name || Rails.application.class.module_parent_name
     end
 
-    # @param [String] application_name the name of the application
-    # @return [void]
+    # Set the name of the application
+    #
+    # @param [String] name the name of the application
     attr_writer :application_name
 
-    # @return [Boolean] whether the gem is in development mode
-    def development?
-      ActiveModel::Type::Boolean.new.cast(ENV["PLUTONIUM_DEV"]).present?
-    end
-
-    # Eager loads Rails application if not already eager loaded
+    # Eager load Rails application if not already eager loaded
+    #
     # @return [void]
     def eager_load_rails!
-      return if Rails.env.production? && defined?(@rails_eager_loaded)
+      return if @rails_eager_loaded || Rails.application.config.eager_load
 
-      Rails.application.eager_load! unless Rails.application.config.eager_load
+      Rails.application.eager_load!
       @rails_eager_loaded = true
     end
   end
 end
 
-Plutonium::ZEITWERK_LOADER = loader
+# Load Railtie if Rails is defined
+require_relative "plutonium/railtie" if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plutonium
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.14.1
 platform: ruby
 authors:
 - Stefan Froelich
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -1095,7 +1095,6 @@ files:
 - lib/generators/pu/rodauth/templates/app/mailers/account_mailer.rb.tt
 - lib/generators/pu/rodauth/templates/app/mailers/rodauth_mailer.rb.tt
 - lib/generators/pu/rodauth/templates/app/models/account.rb.tt
-- lib/generators/pu/rodauth/templates/app/rodauth/account_rodauth_plugin.rb.tt
 - lib/generators/pu/rodauth/templates/app/rodauth/rodauth_app.rb.tt
 - lib/generators/pu/rodauth/templates/app/rodauth/rodauth_plugin.rb.tt
 - lib/generators/pu/rodauth/templates/app/views/rodauth_mailer/email_auth.text.erb
@@ -1120,13 +1119,17 @@ files:
 - lib/generators/pu/service/sidekiq/templates/config/sidekiq.yml
 - lib/plutonium.rb
 - lib/plutonium/application/controller.rb
+- lib/plutonium/application/dynamic_controllers.rb
 - lib/plutonium/auth.rb
 - lib/plutonium/auth/public.rb
 - lib/plutonium/auth/rodauth.rb
 - lib/plutonium/builders/menus/sidebar_menu.rb.bk
 - lib/plutonium/builders/menus/sidebar_menu_item.rb.bk
 - lib/plutonium/component_registry.rb
+- lib/plutonium/concerns/resource_validatable.rb
 - lib/plutonium/config.rb
+- lib/plutonium/config/overlayed_hash.rb
+- lib/plutonium/configuration.rb
 - lib/plutonium/core/.DS_Store
 - lib/plutonium/core/action.rb
 - lib/plutonium/core/actions/basic_action.rb
@@ -1195,6 +1198,7 @@ files:
 - lib/plutonium/lib/bit_flags.rb
 - lib/plutonium/pkg/app.rb
 - lib/plutonium/pkg/base.rb
+- lib/plutonium/pkg/concerns/resource_validatable.rb
 - lib/plutonium/pkg/feature.rb
 - lib/plutonium/policy/initializer.rb
 - lib/plutonium/policy/scope.rb
@@ -1213,9 +1217,14 @@ files:
 - lib/plutonium/resource/presenter.rb
 - lib/plutonium/resource/query_object.rb
 - lib/plutonium/resource/record.rb
+- lib/plutonium/resource_register.rb
 - lib/plutonium/rodauth/controller_methods.rb
+- lib/plutonium/routing/mapper_extensions.rb
+- lib/plutonium/routing/resource_registration.rb
+- lib/plutonium/routing/route_set_extensions.rb
 - lib/plutonium/simple_form/attachment_component.rb
 - lib/plutonium/simple_form/input_group_component.rb
+- lib/plutonium/smart_cache.rb
 - lib/plutonium/version.rb
 - lib/tasks/create_rodauth_admin.rake
 - package-lock.json
@@ -1229,7 +1238,7 @@ files:
 - public/plutonium-assets/plutonium-logo-white.png
 - public/plutonium-assets/plutonium-logo.png
 - public/plutonium-assets/plutonium.ico
-- sig/plutonium.rbs
+- sig/.keep
 - src/.npmignore
 - src/css/plutonium.css
 - src/js/controllers/color_mode_controller.js

data/lib/generators/pu/rodauth/templates/app/rodauth/account_rodauth_plugin.rb.tt

@@ -1,270 +0,0 @@
-require "sequel/core"
-
-class <%= account_path.classify %>RodauthPlugin < RodauthPlugin
-  configure do
-    # This block is running inside of
-    #   plugin :rodauth do
-    #     ...
-    #   end
-
-    # ==> Features
-    # See the Rodauth documentation for the list of available config options:
-    # http://rodauth.jeremyevans.net/documentation.html
-
-    # List of authentication features that are loaded.
-    enable <%= selected_features.map(&:inspect).join ', ' %>
-
-    # ==> General
-
-    # Change prefix of table and foreign key column names from default "account"
-    # accounts_table: 'players'
-
-    # The secret key used for hashing public-facing tokens for various features.
-    # Defaults to Rails `secret_key_base`, but you can use your own secret key.
-    # hmac_secret "<SECRET_KEY>"
-
-    # Use path prefix for all routes.
-    <%= '# ' if primary? %>prefix "/<%= account_path.pluralize %>"
-<% unless separate_passwords? -%>
-
-    # Store password hash in a column instead of a separate table.
-    account_password_hash_column :password_hash
-<% end -%>
-
-    # Specify the controller used for view rendering, CSRF, and callbacks.
-    rails_controller { Rodauth::<%= account_path.classify %>Controller }
-
-    # Specify the model to be used.
-    rails_account_model { <%= account_path.classify %> }
-<% if verify_account? -%>
-
-    # Set password password during create account.
-    # verify_account_set_password? false
-<% end -%>
-
-    # Change some default param keys.
-    # login_param "email"
-    # password_confirm_param "confirm_password"
-<% if login? -%>
-
-    # Redirect back to originally requested location after authentication.
-    login_return_to_requested_location? true
-<% end -%>
-    # two_factor_auth_return_to_requested_location? true # if using MFA
-
-    # Autologin the user after they have reset their password.
-    # reset_password_autologin? true
-
-    # Delete the account record when the user has closed their account.
-    # delete_account_on_close? true
-
-    # Redirect to the app from login and registration pages if already logged in.
-    # already_logged_in { redirect login_redirect }
-<% if jwt? -%>
-
-    # ==> JWT
-
-    # Set JWT secret, which is used to cryptographically protect the token.
-    jwt_secret Rails.application.credentials.secret_key_base
-<% end -%>
-<% if only_json? -%>
-
-    # ==> Api only
-
-    # Accept only JSON requests.
-    only_json? true
-
-    # Handle login and password confirmation fields on the client side.
-    require_password_confirmation? false
-    require_login_confirmation? false
-<% else -%>
-
-    # Accept both api and form requests
-    # Requires the JSON feature
-    <%= '# ' unless json? %>only_json? false
-<% end -%>
-<% if mails? -%>
-
-    # ==> Emails
-    # Use a custom mailer for delivering authentication emails.
-<% if reset_password? -%>
-
-    create_reset_password_email do
-      Rodauth::<%= account_path.classify %>Mailer.reset_password(self.class.configuration_name, account_id, reset_password_key_value)
-    end
-<% end -%>
-<% if verify_account? -%>
-
-    create_verify_account_email do
-      Rodauth::<%= account_path.classify %>Mailer.verify_account(self.class.configuration_name, account_id, verify_account_key_value)
-    end
-<% end -%>
-<% if verify_login_change? -%>
-
-    create_verify_login_change_email do |_login|
-      Rodauth::<%= account_path.classify %>Mailer.verify_login_change(self.class.configuration_name, account_id, verify_login_change_key_value)
-    end
-<% end -%>
-<% if change_password_notify? -%>
-
-    create_password_changed_email do
-      Rodauth::<%= account_path.classify %>Mailer.change_password_notify(self.class.configuration_name, account_id)
-    end
-<% end -%>
-<% if reset_password_notify? -%>
-
-    create_reset_password_notify_email do
-      Rodauth::<%= account_path.classify %>Mailer.reset_password_notify(self.class.configuration_name, account_id)
-    end
-<% end -%>
-<% if email_auth? -%>
-
-    create_email_auth_email do
-      Rodauth::<%= account_path.classify %>Mailer.email_auth(self.class.configuration_name, account_id, email_auth_key_value)
-    end
-<% end -%>
-<% if lockout? -%>
-
-    create_unlock_account_email do
-      Rodauth::<%= account_path.classify %>Mailer.unlock_account(self.class.configuration_name, account_id, unlock_account_key_value)
-    end
-<% end -%>
-
-    send_email do |email|
-      # queue email delivery on the mailer after the transaction commits
-      db.after_commit { email.deliver_later }
-    end
-<% end -%>
-<% unless only_json? -%>
-
-    # ==> Flash
-    # Does not work with only_json?
-
-    # Match flash keys with ones already used in the Rails app.
-    # flash_notice_key :success # default is :notice
-    # flash_error_key :error # default is :alert
-
-    # Override default flash messages.
-    # create_account_notice_flash "Your account has been created. Please verify your account by visiting the confirmation link sent to your email address."
-    # require_login_error_flash "Login is required for accessing this page"
-    # login_notice_flash nil
-<% end -%>
-
-    # ==> Validation
-    # Override default validation error messages.
-    # no_matching_login_message "user with this email address doesn't exist"
-    # already_an_account_with_this_login_message "user with this email address already exists"
-    # password_too_short_message { "needs to have at least #{password_minimum_length} characters" }
-    # login_does_not_meet_requirements_message { "invalid email#{", #{login_requirement_message}" if login_requirement_message}" }
-
-    # ==> Passwords
-
-    # Passwords shorter than 8 characters are considered weak according to OWASP.
-    <%= '# ' unless login? %>password_minimum_length 8
-
-    # Custom password complexity requirements (alternative to password_complexity feature).
-    # password_meets_requirements? do |password|
-    #   super(password) && password_complex_enough?(password)
-    # end
-    # auth_class_eval do
-    #   def password_complex_enough?(password)
-    #     return true if password.match?(/\d/) && password.match?(/[^a-zA-Z\d]/)
-    #     set_password_requirement_error_message(:password_simple, "requires one number and one special character")
-    #     false
-    #   end
-    # end
-<% unless argon2? -%>
-
-    # = bcrypt
-
-    # bcrypt has a maximum input length of 72 bytes, truncating any extra bytes.
-    password_maximum_bytes 72 if respond_to?(:password_maximum_bytes)
-<% else -%>
-
-    # = argon2
-
-    # Use a rotatable password pepper when hashing passwords with Argon2.
-    argon2_secret "TODO: <SECRET_KEY>"
-
-    # Since we're using argon2, prevent loading the bcrypt gem to save memory.
-    require_bcrypt? false
-
-    # Having a maximum password length set prevents long password DoS attacks.
-    password_maximum_length 64 if respond_to?(:password_maximum_length)
-<% end -%>
-<% if remember? -%>
-
-    # ==> Remember Feature
-
-    # Remember all logged in users.
-    after_login { remember_login }
-
-    # Or only remember users that have ticked a "Remember Me" checkbox on login.
-    # after_login { remember_login if param_or_nil("remember") }
-
-    # Extend user's remember period when remembered via a cookie
-    extend_remember_deadline? true
-
-    # Store the user's remember cookie under a namespace
-    remember_cookie_key "_<%= table_prefix %>_remember"
-<% end -%>
-
-    # ==> Hooks
-
-    # Validate custom fields in the create account form.
-    # before_create_account do
-    #   throw_error_status(422, "name", "must be present") if param("name").empty?
-    # end
-
-    # Perform additional actions after the account is created.
-    # after_create_account do
-    #   Profile.create!(account_id: account_id, name: param("name"))
-    # end
-
-    # Do additional cleanup after the account is closed.
-    # after_close_account do
-    #   Profile.find_by!(account_id: account_id).destroy
-    # end
-<% unless only_json? -%>
-
-    # ==> Redirects
-<% if create_account? -%>
-
-    # Redirect to home after login.
-    create_account_redirect "/"
-<% end -%>
-<% if login? -%>
-
-    # Redirect to home after login.
-    login_redirect "/"
-<% end -%>
-<% if logout? -%>
-
-    # Redirect to home page after logout.
-    logout_redirect "/"
-<% end -%>
-<% if verify_account? -%>
-
-    # Redirect to wherever login redirects to after account verification.
-    verify_account_redirect { login_redirect }
-<% end -%>
-<% if reset_password? -%>
-
-    # Redirect to login page after password reset.
-    reset_password_redirect { login_path }
-<% end -%>
-
-    # Ensure requiring login follows login route changes.
-    require_login_redirect { login_path }
-<% end -%>
-
-    # ==> Deadlines
-    # Change default deadlines for some actions.
-    # verify_account_grace_period 3.days.to_i
-    # reset_password_deadline_interval Hash[hours: 6]
-    # verify_login_change_deadline_interval Hash[days: 2]
-<% unless only_json? -%>
-    # remember_deadline_interval Hash[days: 30]
-<% end -%>
-  end
-end

data/sig/plutonium.rbs

@@ -1,12 +0,0 @@
-# plutonium.rbs
-module Plutonium
-  class Error < StandardError; end
-
-  def self.root: () -> Pathname
-  def self.lib_root: () -> Pathname
-  def self.logger: () -> Logger
-  def self.application_name: () -> String
-  def self.application_name=: (String) -> void
-  def self.development?: () -> bool
-  def self.eager_load_rails!: () -> void
-end