ultra_settings 2.6.1 → 2.8.0

data/app/configuration.html.erb

@@ -1,28 +1,28 @@
 <div class="ultra-settings-block">
-  <% if !configuration.class.yaml_config_disabled? && configuration.class.configuration_file.is_a?(Pathname) %>
-    <div class="ultra-settings-config-file">
-      <span class="ultra-settings-config-file-label">Configuration File:</span>
-      <code class="ultra-settings-config-file-path"><%= html_escape(relative_path(configuration.class.configuration_file)) %></code>
-      <% unless configuration.class.configuration_file&.exist? %>
-        <span class="ultra-settings-file-not-found">(File does not exist)</span>
-      <% end %>
-    </div>
-  <% end %>
+  <%= render_partial "config_description", configuration: configuration %>
 
   <div class="ultra-settings-fields">
     <% configuration.class.fields.each do |field| %>
       <% source = configuration.__source__(field.name) %>
+
       <div class="ultra-settings-field">
         <div class="ultra-settings-field-header">
           <div class="ultra-settings-field-name">
             <code><%= html_escape(field.name) %></code>
+
             <% if field.secret? %>
-              <span class="ultra-settings-field-badge ultra-settings-badge-secret">secret</span>
+              <span class="ultra-settings-field-badge ultra-settings-badge-secret">
+                secret
+              </span>
             <% end %>
+
             <% if field.static? %>
-              <span class="ultra-settings-field-badge ultra-settings-badge-static">static</span>
+              <span class="ultra-settings-field-badge ultra-settings-badge-static">
+                static
+              </span>
             <% end %>
           </div>
+
           <div class="ultra-settings-field-type">
             <%= html_escape(field.type) %>
           </div>
@@ -32,15 +32,20 @@
           <% if configuration[field.name].nil? %>
             <span class="ultra-settings-nil-value">nil</span>
           <% elsif field.secret? %>
-            <code class="ultra-settings-field-data-value"><%= html_escape(secret_value(configuration[field.name])) %></code>
+            <code class="ultra-settings-field-data-value">
+              <%= html_escape(secret_value(configuration[field.name])) %>
+            </code>
           <% else %>
-            <code class="ultra-settings-field-data-value"><%= html_escape(display_value(configuration[field.name])) %></code>
+            <code class="ultra-settings-field-data-value">
+              <%= html_escape(display_value(configuration[field.name])) %>
+            </code>
           <% end %>
         </div>
 
         <% unless field.description.to_s.empty? %>
           <div class="ultra-settings-field-description">
             <%= info_icon %>
+
             <div class="ultra-settings-description-text">
               <%= html_escape(field.description) %>
             </div>
@@ -48,61 +53,84 @@
         <% end %>
 
         <div class="ultra-settings-field-sources">
-          <% if field.env_var && !configuration.class.environment_variables_disabled? %>
+          <% sources = configuration.__available_sources__(field.name) %>
+          <% if sources.include?(:env) %>
             <div class="ultra-settings-source <%= 'ultra-settings-source-active' if source == :env %>">
               <span class="ultra-settings-source-type">
                 Environment Variable
               </span>
+
               <code class="ultra-settings-source-value">
                 <%= field.env_var %>
                 <%= show_defined_value(field.env_var, configuration.__value_from_source__(field.name, :env), field.secret?) %>
               </code>
+
               <% if source == :env %>
-                <span class="ultra-settings-source-indicator">Currently active</span>
+                <span class="ultra-settings-source-indicator">
+                  Currently active
+                </span>
               <% end %>
             </div>
           <% end %>
 
-          <% if field.runtime_setting && !configuration.class.runtime_settings_disabled? %>
+          <% if sources.include?(:settings) %>
             <div class="ultra-settings-source <%= 'ultra-settings-source-active' if source == :settings %>">
               <span class="ultra-settings-source-type">Runtime Setting</span>
+
               <code class="ultra-settings-source-value">
                 <%= field.runtime_setting %>
                 <%= show_defined_value(field.runtime_setting, configuration.__value_from_source__(field.name, :settings), field.secret?) %>
               </code>
+
               <% if source == :settings %>
-                <span class="ultra-settings-source-indicator">Currently active</span>
+                <span class="ultra-settings-source-indicator">
+                  Currently active
+                </span>
               <% end %>
-              <% edit_url = UltraSettings.runtime_settings_url(field.runtime_setting, field.type) %>
+
+              <% edit_url = UltraSettings.runtime_settings_url(name: field.runtime_setting, type: field.type, description: field.description) %>
+
               <% if edit_url %>
-                <a href="<%= html_escape(edit_url) %>" class="ultra-settings-edit-link" title="Edit <%= html_escape(field.runtime_setting) %>">
+                <a
+                  href="<%= html_escape(edit_url) %>"
+                  class="ultra-settings-edit-link"
+                  title="Edit <%= html_escape(field.runtime_setting) %>"
+                >
                   <%= edit_icon %>
                 </a>
               <% end %>
             </div>
           <% end %>
 
-          <% if field.yaml_key && !configuration.class.yaml_config_disabled? %>
+          <% if sources.include?(:yaml) %>
             <div class="ultra-settings-source <%= 'ultra-settings-source-active' if source == :yaml %>">
               <span class="ultra-settings-source-type">Configuration File</span>
+
               <code class="ultra-settings-source-value">
                 <%= field.yaml_key %>
                 <%= show_defined_value(field.yaml_key, configuration.__value_from_source__(field.name, :yaml), field.secret?) %>
               </code>
+
               <% if source == :yaml %>
-                <span class="ultra-settings-source-indicator">Currently active</span>
+                <span class="ultra-settings-source-indicator">
+                  Currently active
+                </span>
               <% end %>
             </div>
           <% end %>
 
-          <% if !field.default.nil? || source == :default %>
+          <% if sources.include?(:default) || source == :default %>
             <div class="ultra-settings-source <%= 'ultra-settings-source-active' if source == :default %>">
               <span class="ultra-settings-source-type">Default Value</span>
+
               <code class="ultra-settings-source-value">
                 <%= show_defined_value("Default Value", field.default, field.secret?) %>
               </code>
+
               <% if source == :default %>
-                <span class="ultra-settings-source-indicator">Currently active</span>
+                <span class="ultra-settings-source-indicator">
+                  Currently active
+                </span>
               <% end %>
             </div>
           <% end %>
@@ -114,10 +142,15 @@
   <dialog class="ultra-settings-dialog" closedby="any">
     <div class="ultra-settings-dialog-header">
       <div class="ultra-settings-dialog-title"></div>
-      <button class="ultra-settings-dialog-close" onclick="this.closest('.ultra-settings-dialog').close();">
+
+      <button
+        class="ultra-settings-dialog-close"
+        onclick="this.closest('.ultra-settings-dialog').close();"
+      >
         <%= close_icon %>
       </button>
     </div>
+
     <div class="ultra-settings-dialog-body">
       <code class="ultra-settings-field-data-value ultra-settings-dialog-value"></code>
     </div>

data/app/index.html.erb

@@ -2,25 +2,30 @@
 
 <div class="ultra-settings">
   <div class="ultra-settings-nav">
-    <form onsubmit="return false" style="margin-bottom: 0.5rem;">
-      <select class="<%= html_escape(select_class) %>" size="1" id="config-selector">
-        <% UltraSettings.__configuration_names__.sort.each do |name| %>
-          <% configuration = UltraSettings.send(name) %>
-          <% next if configuration.class.fields.empty? %>
+    <% configurations = UltraSettings.__configurations__.reject { |config| config.class.fields.empty? }.sort_by { |config| config.class.name.downcase } %>
 
-          <option value="config-<%= html_escape(name) %>"><%= html_escape(UltraSettings.send(name).class.name) %></option>
-        <% end %>
-      </select>
-    </form>
+    <% if configurations.size == 1 %>
+      <h2 class="ultra-settings-title">
+        <%= html_escape(configurations.first.class.name) %>
+      </h2>
+    <% else %>
+      <%= render_partial "select_menu", configurations: configurations %>
+    <% end %>
   </div>
 
-  <% UltraSettings.__configuration_names__.sort.each do |name| %>
-    <% configuration = UltraSettings.send(name) %>
-    <% next if configuration.class.fields.empty? %>
-
-    <div class="ultra-settings-configuration" id="config-<%= html_escape(name) %>" style="display:none;">
-      <%= UltraSettings::ConfigurationView.new(configuration).render(table_class: table_class) %>
-    </div>
+  <% if configurations.size == 1 %>
+    <%= UltraSettings::ConfigurationView.new(configurations.first).render(table_class: table_class) %>
+  <% else %>
+    <%= render_partial "config_list", configurations: configurations %>
+    <% configurations.each do |configuration| %>
+      <div
+        class="ultra-settings-configuration"
+        id="config-<%= html_escape(configuration.class.name) %>"
+        style="display:none;"
+      >
+        <%= UltraSettings::ConfigurationView.new(configuration).render(table_class: table_class) %>
+      </div>
+    <% end %>
   <% end %>
 </div>
 

data/lib/ultra_settings/application_view.rb

@@ -4,44 +4,54 @@ module UltraSettings
   # This class can render information about all configurations. It is used by the bundled
   # web UI, but you can use it to embed the configuration information in your own web pages.
   #
-  # The output will be a simple HTML drop down list that can be used to display an HTML element
-  # showing each configuration. You can specify the CSS class for the select element by passing
-  # the `select_class` option to the `render` method. By default the select element has
-  # the class `ultra-settings-select`.
+  # The output will be a simple HTML drop down menu that can be used to select the configuration
+  # you want to see.
   #
   # @example
   #  <h1>Application Configuration</h1>
-  #  <%= UltraSettings::ApplicationView.new.render(select_class: 'form-control') %>
+  #  <%= UltraSettings::ApplicationView.new.render %>
   class ApplicationView
+    include RenderHelper
+
     attr_reader :css
 
+    # Initialize the application view with a color scheme.
+    #
+    # @param color_scheme [Symbol] The color scheme to use (:light, :dark, or :system).
     def initialize(color_scheme: :light)
       @css = application_css(color_scheme)
       @css = @css.html_safe if @css.respond_to?(:html_safe)
     end
 
-    def render(select_class: "ultra-settings-select", table_class: "")
+    # Render the HTML for the configuration settings UI.
+    #
+    # @param select_class [String] Deprecated; no longer used.
+    # @param table_class [String] Deprecated; no longer used.
+    # @return [String] The rendered HTML.
+    def render(select_class: nil, table_class: nil)
       html = ViewHelper.erb_template("index.html.erb").result(binding)
       html = html.html_safe if html.respond_to?(:html_safe)
       html
     end
 
+    # Generate an HTML style tag with the CSS for the view.
+    #
+    # @return [String] The HTML style tag with CSS.
     def style_tag
       tag = "<style type=\"text/css\">\n#{css}\n</style>"
       tag = tag.html_safe if tag.respond_to?(:html_safe)
       tag
     end
 
+    # Convert the view to a string by rendering it.
+    #
+    # @return [String] The rendered HTML.
     def to_s
       render
     end
 
     private
 
-    def html_escape(value)
-      ERB::Util.html_escape(value)
-    end
-
     def javascript
       ViewHelper.read_app_file("application.js")
     end

data/lib/ultra_settings/coerce.rb

@@ -93,11 +93,13 @@ module UltraSettings
         time
       end
 
+      # @param value [Object] The value to check.
       # @return [Boolean] true if the value is a numeric type or a string representing a number.
       def numeric?(value)
         value.is_a?(Numeric) || (value.is_a?(String) && value.to_s.match?(NUMERIC_REGEX))
       end
 
+      # @param value [Object] The value to check.
       # @return [Boolean] true if the value is nil or empty.
       def blank?(value)
         return true if value.nil?
@@ -109,6 +111,7 @@ module UltraSettings
         end
       end
 
+      # @param value [Object] The value to check.
       # @return [Boolean] true if the value is not nil and not empty.
       def present?(value)
         !blank?(value)

data/lib/ultra_settings/config_helper.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
 module UltraSettings
-  # Helper module for setting up a class to use the config methods
+  # Helper module for setting up a class to use the config methods.
   #
-  # Usage:
-  # class TestClass
-  #   extend UltraSettings::ConfigHelper
-  #   configuration_class TestConfiguration
-  # end
-  # TestClass.config => TestConfiguration.instance
-  # TestClass.new.config => TestConfiguration.instance
+  # @example
+  #   class TestClass
+  #     extend UltraSettings::ConfigHelper
+  #     configuration_class TestConfiguration
+  #   end
+  #   TestClass.config # => TestConfiguration.instance
+  #   TestClass.new.config # => TestConfiguration.instance
   module ConfigHelper
+    # Define the configuration class and create config methods.
+    #
+    # @param config_class [Class] The configuration class to use.
+    # @return [void]
     def configuration_class(config_class)
       define_singleton_method :config do
         config_class.instance

data/lib/ultra_settings/configuration.rb

@@ -9,8 +9,20 @@ module UltraSettings
 
     @env_var_prefix = nil
     @runtime_setting_prefix = nil
+    @description = nil
 
     class << self
+      # Set a description for the configuration. This is optional. It will be displayed
+      # in the web UI if provided. On large projects with many configurations, this can
+      # help identify the purpose of each configuration.
+      #
+      # @param text [String] The description text.
+      # @return [void]
+      def description(text = nil)
+        @description = text.to_s.strip unless text.nil?
+        @description
+      end
+
       # Define a field on the configuration. This will create a getter method for the field.
       # The field value will be read from the environment, runtime settings, or a YAML file
       # and coerced to the specified type. Empty strings will be converted to nil.
@@ -27,14 +39,19 @@ module UltraSettings
       # @param static [Boolean] If true, the field value should never be changed. This is useful for
       #   fields that are used at startup to set static values in the application. Static field cannot
       #   be read from runtime settings.
-      # @param runtime_setting [String, Symbol] The name of the runtime setting to use for the field.
+      # @param secret [Boolean, Proc] If true, the field value will be obscured in the output of
+      #   to_hash. If a proc is provided, it will be called to determine if the field is secret.
+      # @param runtime_setting [String, Symbol, Boolean] The name of the runtime setting to use for the field.
       #   By default this will be the underscored name of the class plus a dot plus the field name
-      #   (i.e. MyServiceConfiguration#foo becomes "my_service.foo").
-      # @param env_var [String, Symbol] The name of the environment variable to use for the field.
+      #   (i.e. MyServiceConfiguration#foo becomes "my_service.foo"). If set to false, runtime settings
+      #   will be ignored for this field. This can be set to true to use the default name.
+      # @param env_var [String, Symbol, Boolean] The name of the environment variable to use for the field.
       #   By default this will be the underscored name of the class plus an underscore plus the field name
-      #   all in uppercase (i.e. MyServiceConfiguration#foo becomes "MY_SERVICE_FOO").
-      # @param yaml_key [String, Symbol] The name of the YAML key to use for the field. By default
-      #   this is the name of the field.
+      #   all in uppercase (i.e. MyServiceConfiguration#foo becomes "MY_SERVICE_FOO"). If set to false,
+      #   environment variables will be ignored for this field. This can be set to true to use the default name.
+      # @param yaml_key [String, Symbol, Boolean] The name of the YAML key to use for the field. By default
+      #   this is the name of the field. If set to false, YAML configuration will be ignored for this field.
+      #   This can be set to true to use the default name.
       # @return [void]
       def field(name, type: :string, description: nil, default: nil, default_if: nil, static: nil, secret: nil, runtime_setting: nil, env_var: nil, yaml_key: nil)
         name = name.to_s
@@ -61,7 +78,7 @@ module UltraSettings
           default: default,
           default_if: default_if,
           env_var: construct_env_var(name, env_var),
-          runtime_setting: (static ? nil : construct_runtime_setting(name, runtime_setting)),
+          runtime_setting: construct_runtime_setting(name, runtime_setting),
           yaml_key: construct_yaml_key(name, yaml_key),
           static: static,
           secret: secret
@@ -145,7 +162,7 @@ module UltraSettings
       # directory (i.e. MyServiceConfiguration has a default config path of
       # "my_service.yml").
       #
-      # @param value [String, Pathname]
+      # @param value [String, Pathname, false, nil]
       # @return [void]
       def configuration_file=(value)
         value = nil if value == false
@@ -513,6 +530,22 @@ module UltraSettings
       end
     end
 
+    # Returns an array of the available data sources for the field.
+    #
+    # @param name [String, Symbol] the name of the field.
+    # @return [Array<Symbol>] The available sources (:env, :settings, :yaml, :default).
+    def __available_sources__(name)
+      field = self.class.send(:defined_fields)[name.to_s]
+      raise ArgumentError.new("Unknown field: #{name.inspect}") unless field
+
+      sources = []
+      sources << :env if field.env_var
+      sources << :settings if field.runtime_setting && UltraSettings.__runtime_settings__
+      sources << :yaml if field.yaml_key && self.class.configuration_file
+      sources << :default unless field.default.nil?
+      sources
+    end
+
     # Output the current state of the configuration as a hash. If the field is marked as a secret,
     # then the value will be a secure hash of the value instead of the value itself.
     #

data/lib/ultra_settings/configuration_view.rb

@@ -11,10 +11,19 @@ module UltraSettings
   #  <h1>Service Configuration</h1>
   #  <%= UltraSettings::ConfigurationView.new(ServiceConfiguration.instance).render %>
   class ConfigurationView
+    include RenderHelper
+
+    # Initialize the configuration view with a configuration instance.
+    #
+    # @param configuration [UltraSettings::Configuration] The configuration instance to display.
     def initialize(configuration)
       @configuration = configuration
     end
 
+    # Render the HTML for the configuration view.
+    #
+    # @param table_class [String] CSS class for the table element (maintained for backwards compatibility).
+    # @return [String] The rendered HTML.
     def render(table_class: "")
       configuration = @configuration
       html = ViewHelper.erb_template("configuration.html.erb").result(binding)
@@ -22,16 +31,15 @@ module UltraSettings
       html
     end
 
+    # Convert the view to a string by rendering it.
+    #
+    # @return [String] The rendered HTML.
     def to_s
       render
     end
 
     private
 
-    def html_escape(value)
-      ERB::Util.html_escape(value)
-    end
-
     def display_value(value)
       case value
       when Time
@@ -137,8 +145,6 @@ module UltraSettings
       HTML
     end
 
-    private
-
     def open_dialog_script
       <<~JAVASCRIPT.gsub(/\s+/, " ").tr('"', "'")
         this.closest('.ultra-settings-configuration').querySelector('.ultra-settings-dialog-title').textContent = this.dataset.label;

data/lib/ultra_settings/field.rb

@@ -16,12 +16,12 @@ module UltraSettings
     # @param type [Symbol] The type of the field.
     # @param description [String] The description of the field.
     # @param default [Object] The default value of the field.
-    # @param default_if [Proc] A proc that returns true if the default value should be used.
+    # @param default_if [Proc, Symbol] A proc that returns true if the default value should be used.
     # @param env_var [String, Symbol] The name of the environment variable to use for the field.
     # @param runtime_setting [String, Symbol] The name of the setting to use for the field.
     # @param yaml_key [String, Symbol] The name of the YAML key to use for the field.
     # @param static [Boolean] Whether or not the field is static and cannot be changed at runtime.
-    # @param secret [Boolean] Whether or not the field contains a value that should be kept secret.
+    # @param secret [Boolean, Proc] Whether or not the field contains a value that should be kept secret.
     def initialize(
       name:,
       type: :string,
@@ -118,6 +118,7 @@ module UltraSettings
     end
 
     def runtime_setting_value(settings)
+      return nil if static? || (secret? && !UltraSettings.runtime_settings_secure?)
       return nil unless settings && runtime_setting
 
       if type == :array && settings.respond_to?(:array)

data/lib/ultra_settings/rack_app.rb

@@ -5,11 +5,18 @@ module UltraSettings
   # No setting values are displayed, but you should still add some
   # sort of authentication if you want to use this in production.
   class RackApp
+    # Initialize a new Rack application for displaying settings.
+    #
+    # @param color_scheme [Symbol, nil] The color scheme to use in the UI (:light, :dark, or :system).
     def initialize(color_scheme: nil)
       @webview = nil
       @color_scheme = color_scheme
     end
 
+    # Handle Rack requests and return the settings HTML page.
+    #
+    # @param env [Hash] The Rack environment.
+    # @return [Array] A Rack response array [status, headers, body].
     def call(env)
       [200, {"content-type" => "text/html; charset=utf8"}, [webview.render_settings]]
     end

data/lib/ultra_settings/render_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module UltraSettings
+  # Helper methods for rendering views.
+  module RenderHelper
+    # HTML escape a value.
+    #
+    # @param value [String] The value to escape.
+    # @return [String] The escaped value.
+    def html_escape(value)
+      ERB::Util.html_escape(value)
+    end
+
+    # Render a partial template with the given locals.
+    #
+    # @param partial_name [String] The name of the partial template (without the leading underscore and file extension).
+    # @param locals [Hash] A hash of local variables to pass to the template.
+    # @return [String] The rendered HTML of the partial.
+    def render_partial(partial_name, locals = {})
+      template = ViewHelper.erb_template("_#{partial_name}.html.erb")
+      b = binding
+      locals.each do |key, value|
+        b.local_variable_set(key, value)
+      end
+      template.result(b)
+    end
+  end
+end

data/lib/ultra_settings/uninitialized_runtime_settings.rb

@@ -3,26 +3,31 @@
 module UltraSettings
   # This class is used to represent runtime settings that have not been initialized yet.
   # You can use this to protect your application from accidentally accessing runtime settings
-  # before they are initialized. Doing this can cquse unexpected behavior if the runtime settings
-  # engine has not yet been initialized. For instance, if your runtime settings enging reads from
+  # before they are initialized. Doing this can cause unexpected behavior if the runtime settings
+  # engine has not yet been initialized. For instance, if your runtime settings engine reads from
   # a database it would not be available until the database connection is established.
   #
-  # The intention of this class is to set it a the runtime settings at the beginning of initialization
+  # The intention of this class is to set it as the runtime settings at the beginning of initialization
   # and then set the actual runtime settings engine after the initialization is complete. It will
   # act as a guard to prevent invalid runtime settings backed configurations from being used during
   # initialization.
   #
   # @example
   #
-  # UltraSettings.runtime_settings = UltraSettings::UninitializedRuntimeSettings
-  # ActiveSupport.on_load(:active_record) do
-  #   UltraSettings.runtime_settings = SuperSettings
-  # end
+  #   UltraSettings.runtime_settings = UltraSettings::UninitializedRuntimeSettings
+  #   ActiveSupport.on_load(:active_record) do
+  #     UltraSettings.runtime_settings = SuperSettings
+  #   end
   class UninitializedRuntimeSettings
     class Error < StandardError
     end
 
     class << self
+      # Raises an error when attempting to access runtime settings during initialization.
+      #
+      # @param key [String] The key being accessed.
+      # @return [void]
+      # @raise [Error] Always raises an error to prevent access during initialization.
       def [](key)
         raise Error.new("Attempt to call runtime setting #{key} during initialization")
       end

data/lib/ultra_settings/view_helper.rb

@@ -6,17 +6,36 @@ module UltraSettings
     @cache = {}
 
     class << self
+      # Get an ERB template for rendering.
+      #
+      # @param path [String] The path to the template file.
+      # @return [ERB] The compiled ERB template.
       def erb_template(path)
+        @cache.clear if development_mode?
         @cache["erb:#{path}"] ||= ERB.new(read_app_file(path))
       end
 
+      # Read a file from the app directory.
+      #
+      # @param path [String] The path to the file relative to the app directory.
+      # @return [String] The contents of the file.
       def read_app_file(path)
+        @cache.clear if development_mode?
         @cache["file:#{path}"] ||= File.read(File.join(app_dir, path))
       end
 
+      # Get the app directory path.
+      #
+      # @return [String] The absolute path to the app directory.
       def app_dir
         File.expand_path(File.join("..", "..", "app"), __dir__)
       end
+
+      private
+
+      def development_mode?
+        ENV.fetch("RACK_ENV", "development") == "development"
+      end
     end
   end
 end

data/lib/ultra_settings/web_view.rb

@@ -5,18 +5,26 @@ module UltraSettings
   class WebView
     attr_reader :layout_css
 
+    # Initialize a new WebView with the specified color scheme.
+    #
     # @param color_scheme [Symbol] The color scheme to use in the UI. This can be `:light`,
-    #  `:dark`, or `:system`. The default is `:light`.
+    #   `:dark`, or `:system`. The default is `:light`.
     def initialize(color_scheme: :light)
       @color_scheme = (color_scheme || :light).to_sym
       @layout_template = ViewHelper.erb_template("layout.html.erb")
       @layout_css = scheme_layout_css(@color_scheme)
     end
 
+    # Render the complete settings page HTML.
+    #
+    # @return [String] The rendered HTML page.
     def render_settings
       @layout_template.result(binding)
     end
 
+    # Get the content for the settings page.
+    #
+    # @return [String] The HTML content for the settings.
     def content
       UltraSettings::ApplicationView.new(color_scheme: @color_scheme).render
     end