rsb-admin 0.9.1

data/lib/rsb/admin.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require 'rsb/settings'
+require 'rotp'
+require 'rqrcode'
+require 'rsb/admin/version'
+require 'rsb/admin/engine'
+require 'rsb/admin/configuration'
+require 'rsb/admin/registry'
+require 'rsb/admin/resource_registration'
+require 'rsb/admin/category_registration'
+require 'rsb/admin/column_definition'
+require 'rsb/admin/filter_definition'
+require 'rsb/admin/form_field_definition'
+require 'rsb/admin/page_registration'
+require 'rsb/admin/resource_dsl_context'
+require 'rsb/admin/breadcrumb_item'
+require 'rsb/admin/theme_definition'
+require 'rsb/admin/settings_schema'
+require 'rsb/admin/icons'
+require 'rsb/admin/themes/modern'
+
+module RSB
+  module Admin
+    class << self
+      def registry
+        @registry ||= Registry.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def settings_schema
+        @settings_schema ||= SettingsSchema.build
+      end
+
+      # Registers a theme definition.
+      #
+      # Themes are stored in a module-level hash and can be referenced by
+      # their key symbol. Use this to register custom themes or override
+      # built-in themes.
+      #
+      # @param key [Symbol, String] the unique theme identifier
+      # @param label [String] the human-readable theme name
+      # @param css [String] the asset path for the theme's CSS file
+      # @param js [String, nil] optional asset path for the theme's JavaScript file
+      # @param views_path [String, nil] optional view override path prefix
+      #
+      # @return [RSB::Admin::ThemeDefinition] the registered theme definition
+      #
+      # @example Register a custom theme
+      #   RSB::Admin.register_theme :corporate,
+      #     label: "Corporate",
+      #     css: "my_app/admin/corporate",
+      #     js: "my_app/admin/corporate",
+      #     views_path: "my_app/admin/corporate/views"
+      def register_theme(key, label:, css:, js: nil, views_path: nil)
+        @themes ||= {}
+        @themes[key.to_sym] = ThemeDefinition.new(
+          key: key.to_sym,
+          label: label,
+          css: css,
+          js: js,
+          views_path: views_path
+        )
+      end
+
+      # Returns all registered themes.
+      #
+      # @return [Hash{Symbol => RSB::Admin::ThemeDefinition}] a hash of theme definitions keyed by their symbol
+      #
+      # @example
+      #   RSB::Admin.themes
+      #   # => { default: #<data RSB::Admin::ThemeDefinition...>, modern: #<data...> }
+      def themes
+        @themes || {}
+      end
+
+      # Returns the ThemeDefinition for the currently configured theme.
+      #
+      # Reads from the settings DB so changes made via the admin panel
+      # take effect immediately without restart.  Falls back to
+      # +configuration.theme+ (initializer value) when settings are not
+      # yet available, and ultimately to the +:default+ theme.
+      #
+      # @return [RSB::Admin::ThemeDefinition] the active theme definition
+      #
+      # @example
+      #   RSB::Settings.set("admin", "theme", "modern")
+      #   RSB::Admin.current_theme
+      #   # => #<data RSB::Admin::ThemeDefinition key=:modern, ...>
+      def current_theme
+        theme_key = RSB::Settings.get('admin.theme').presence || configuration.theme
+        themes[theme_key.to_sym] || themes[:default]
+      end
+
+      # Checks whether the admin panel is enabled.
+      #
+      # Uses a special resolution order for safety: ENV has highest priority
+      # (overrides DB), so a developer can always force-enable via
+      # RSB_ADMIN_ENABLED=true without needing database access.
+      #
+      # Resolution: ENV['RSB_ADMIN_ENABLED'] → DB → initializer → default (true)
+      #
+      # @return [Boolean] true if the admin panel is enabled
+      #
+      # @example
+      #   RSB::Admin.enabled?  # => true (default)
+      #
+      # @example Force-enable via ENV
+      #   ENV['RSB_ADMIN_ENABLED'] = 'true'
+      #   RSB::Admin.enabled?  # => true (even if DB says false)
+      def enabled?
+        # ENV override has highest priority (escape hatch)
+        return ActiveModel::Type::Boolean.new.cast(ENV['RSB_ADMIN_ENABLED']) if ENV.key?('RSB_ADMIN_ENABLED')
+
+        # Normal settings resolution: DB → initializer → default
+        RSB::Settings.get('admin.enabled') != false
+      end
+
+      def reset!
+        @registry = Registry.new
+        @configuration = Configuration.new
+        @settings_schema = nil
+        @themes = {}
+        register_built_in_themes
+      end
+
+      # Convenience method to render an icon SVG.
+      #
+      # This is a shorthand for {RSB::Admin::Icons.render}.
+      # Useful when you need to render icons outside of view context.
+      #
+      # @param name [String, Symbol] The icon name (e.g., "users", :home)
+      # @param size [Integer] The width and height of the icon in pixels
+      #
+      # @return [ActiveSupport::SafeBuffer] HTML-safe SVG string, or empty string if icon not found
+      #
+      # @example
+      #   RSB::Admin.icon("users")
+      #   # => '<svg xmlns="..." width="18" height="18" ...>...</svg>'
+      #
+      # @example
+      #   RSB::Admin.icon(:home, size: 32)
+      #   # => '<svg xmlns="..." width="32" height="32" ...>...</svg>'
+      #
+      # @see RSB::Admin::Icons.render
+      def icon(name, size: 18)
+        Icons.render(name, size: size)
+      end
+
+      private
+
+      # Registers the built-in themes (default and modern).
+      #
+      # This is called automatically at module load time and after {#reset!}.
+      #
+      # @api private
+      def register_built_in_themes
+        register_theme :default,
+                       label: 'Default',
+                       css: 'rsb/admin/themes/default',
+                       views_path: nil
+
+        Themes::Modern.register!
+      end
+    end
+
+    # Register built-in themes at load time
+    register_built_in_themes
+  end
+end

data/lib/tasks/rsb/admin_tasks.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+namespace :rsb do
+  desc 'Create an admin user. Usage: rsb:create_admin EMAIL=admin@example.com PASSWORD=secret'
+  task create_admin: :environment do
+    email = ENV.fetch('EMAIL') { abort 'EMAIL is required' }
+    password = ENV.fetch('PASSWORD') { abort 'PASSWORD is required' }
+
+    # Create superadmin role if it doesn't exist
+    role = RSB::Admin::Role.find_or_create_by!(name: 'Superadmin') do |r|
+      r.permissions = { '*' => ['*'] }
+      r.built_in = true
+    end
+
+    admin = RSB::Admin::AdminUser.create!(
+      email: email,
+      password: password,
+      password_confirmation: password,
+      role: role
+    )
+    puts "Admin user created: #{admin.email} (role: #{role.name})"
+  end
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: rsb-admin
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Aleksandr Marchenko
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: rotp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rsb-settings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: Registrable admin panel with dynamic RBAC, settings page, and a test
+  kit for extension developers. Simpler than ActiveAdmin — designed for extensibility.
+email:
+- alex@marchenko.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/rsb/admin/themes/modern.js
+- app/assets/stylesheets/rsb/admin/themes/default.css
+- app/assets/stylesheets/rsb/admin/themes/modern.css
+- app/controllers/concerns/rsb/admin/authorization.rb
+- app/controllers/rsb/admin/admin_controller.rb
+- app/controllers/rsb/admin/admin_users_controller.rb
+- app/controllers/rsb/admin/dashboard_controller.rb
+- app/controllers/rsb/admin/profile_controller.rb
+- app/controllers/rsb/admin/profile_sessions_controller.rb
+- app/controllers/rsb/admin/resources_controller.rb
+- app/controllers/rsb/admin/roles_controller.rb
+- app/controllers/rsb/admin/sessions_controller.rb
+- app/controllers/rsb/admin/settings_controller.rb
+- app/controllers/rsb/admin/two_factor_controller.rb
+- app/helpers/rsb/admin/authorization_helper.rb
+- app/helpers/rsb/admin/branding_helper.rb
+- app/helpers/rsb/admin/formatting_helper.rb
+- app/helpers/rsb/admin/i18n_helper.rb
+- app/helpers/rsb/admin/icons_helper.rb
+- app/helpers/rsb/admin/table_helper.rb
+- app/helpers/rsb/admin/theme_helper.rb
+- app/helpers/rsb/admin/url_helper.rb
+- app/mailers/rsb/admin/admin_mailer.rb
+- app/models/rsb/admin/admin_session.rb
+- app/models/rsb/admin/admin_user.rb
+- app/models/rsb/admin/application_record.rb
+- app/models/rsb/admin/role.rb
+- app/views/layouts/rsb/admin/application.html.erb
+- app/views/rsb/admin/admin_mailer/email_verification.html.erb
+- app/views/rsb/admin/admin_mailer/email_verification.text.erb
+- app/views/rsb/admin/admin_users/_form.html.erb
+- app/views/rsb/admin/admin_users/edit.html.erb
+- app/views/rsb/admin/admin_users/index.html.erb
+- app/views/rsb/admin/admin_users/new.html.erb
+- app/views/rsb/admin/admin_users/show.html.erb
+- app/views/rsb/admin/dashboard/index.html.erb
+- app/views/rsb/admin/profile/edit.html.erb
+- app/views/rsb/admin/profile/show.html.erb
+- app/views/rsb/admin/resources/_filters.html.erb
+- app/views/rsb/admin/resources/_form.html.erb
+- app/views/rsb/admin/resources/_pagination.html.erb
+- app/views/rsb/admin/resources/_table.html.erb
+- app/views/rsb/admin/resources/edit.html.erb
+- app/views/rsb/admin/resources/index.html.erb
+- app/views/rsb/admin/resources/new.html.erb
+- app/views/rsb/admin/resources/page.html.erb
+- app/views/rsb/admin/resources/show.html.erb
+- app/views/rsb/admin/roles/_form.html.erb
+- app/views/rsb/admin/roles/edit.html.erb
+- app/views/rsb/admin/roles/index.html.erb
+- app/views/rsb/admin/roles/new.html.erb
+- app/views/rsb/admin/roles/show.html.erb
+- app/views/rsb/admin/sessions/new.html.erb
+- app/views/rsb/admin/sessions/two_factor.html.erb
+- app/views/rsb/admin/settings/_field.html.erb
+- app/views/rsb/admin/settings/index.html.erb
+- app/views/rsb/admin/shared/_badge.html.erb
+- app/views/rsb/admin/shared/_breadcrumbs.html.erb
+- app/views/rsb/admin/shared/_empty_state.html.erb
+- app/views/rsb/admin/shared/_flash.html.erb
+- app/views/rsb/admin/shared/_header.html.erb
+- app/views/rsb/admin/shared/_page_tabs.html.erb
+- app/views/rsb/admin/shared/_sidebar.html.erb
+- app/views/rsb/admin/shared/disabled.html.erb
+- app/views/rsb/admin/shared/fields/_checkbox.html.erb
+- app/views/rsb/admin/shared/fields/_datetime.html.erb
+- app/views/rsb/admin/shared/fields/_email.html.erb
+- app/views/rsb/admin/shared/fields/_hidden.html.erb
+- app/views/rsb/admin/shared/fields/_json.html.erb
+- app/views/rsb/admin/shared/fields/_number.html.erb
+- app/views/rsb/admin/shared/fields/_password.html.erb
+- app/views/rsb/admin/shared/fields/_select.html.erb
+- app/views/rsb/admin/shared/fields/_text.html.erb
+- app/views/rsb/admin/shared/fields/_textarea.html.erb
+- app/views/rsb/admin/shared/forbidden.html.erb
+- app/views/rsb/admin/themes/modern/views/shared/_header.html.erb
+- app/views/rsb/admin/themes/modern/views/shared/_sidebar.html.erb
+- app/views/rsb/admin/two_factor/backup_codes.html.erb
+- app/views/rsb/admin/two_factor/new.html.erb
+- config/locales/en.yml
+- config/locales/seo.en.yml
+- config/routes.rb
+- db/migrate/20260208000003_create_rsb_admin_tables.rb
+- db/migrate/20260214000001_add_otp_fields_to_rsb_admin_admin_users.rb
+- lib/generators/rsb/admin/install/install_generator.rb
+- lib/generators/rsb/admin/install/templates/rsb_admin_seeds.rb
+- lib/generators/rsb/admin/theme/templates/theme.css.tt
+- lib/generators/rsb/admin/theme/theme_generator.rb
+- lib/generators/rsb/admin/views/views_generator.rb
+- lib/rsb/admin.rb
+- lib/rsb/admin/breadcrumb_item.rb
+- lib/rsb/admin/category_registration.rb
+- lib/rsb/admin/column_definition.rb
+- lib/rsb/admin/configuration.rb
+- lib/rsb/admin/engine.rb
+- lib/rsb/admin/filter_definition.rb
+- lib/rsb/admin/form_field_definition.rb
+- lib/rsb/admin/icons.rb
+- lib/rsb/admin/page_registration.rb
+- lib/rsb/admin/registry.rb
+- lib/rsb/admin/resource_dsl_context.rb
+- lib/rsb/admin/resource_registration.rb
+- lib/rsb/admin/settings_schema.rb
+- lib/rsb/admin/test_kit.rb
+- lib/rsb/admin/test_kit/helpers.rb
+- lib/rsb/admin/test_kit/resource_test_case.rb
+- lib/rsb/admin/theme_definition.rb
+- lib/rsb/admin/themes/modern.rb
+- lib/rsb/admin/version.rb
+- lib/tasks/rsb/admin_tasks.rake
+homepage: https://github.com/Rails-SaaS-Builder/rails-saas-builder
+licenses:
+- LGPL-3.0
+metadata:
+  source_code_uri: https://github.com/Rails-SaaS-Builder/rails-saas-builder
+  bug_tracker_uri: https://github.com/Rails-SaaS-Builder/rails-saas-builder/issues
+  changelog_uri: https://github.com/Rails-SaaS-Builder/rails-saas-builder/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: Lightweight admin panel framework for Rails SaaS Builder
+test_files: []