ultra_settings 2.6.1 → 2.8.0

data/lib/ultra_settings/yaml_config.rb

@@ -33,11 +33,18 @@ module UltraSettings
   # In addition, the keys are flattened into a one level deep hash with dots
   # separating the keys.
   class YamlConfig
+    # Initialize a YAML configuration loader.
+    #
+    # @param path [String, Pathname] The path to the YAML configuration file.
+    # @param environment [String] The environment section to load from the YAML file.
     def initialize(path, environment)
       yaml = load_yaml(path)
       @config = environment_config(yaml, environment)
     end
 
+    # Convert the loaded configuration to a hash.
+    #
+    # @return [Hash] The flattened configuration hash.
     def to_h
       @config
     end

data/lib/ultra_settings.rb

@@ -14,6 +14,7 @@ require_relative "ultra_settings/config_helper"
 require_relative "ultra_settings/field"
 require_relative "ultra_settings/rack_app"
 require_relative "ultra_settings/view_helper"
+require_relative "ultra_settings/render_helper"
 require_relative "ultra_settings/web_view"
 require_relative "ultra_settings/application_view"
 require_relative "ultra_settings/configuration_view"
@@ -38,6 +39,7 @@ module UltraSettings
   @mutex = Mutex.new
   @runtime_settings = nil
   @runtime_settings_url = nil
+  @runtime_settings_secure = true
 
   class << self
     # Adds a configuration to the root namespace. The configuration will be
@@ -111,6 +113,7 @@ module UltraSettings
     # Defaults to "development".
     #
     # @param value [String] The environment name to use.
+    # @return [void]
     def yaml_config_env=(value)
       Configuration.yaml_config_env = value
     end
@@ -128,6 +131,7 @@ module UltraSettings
     # this is a period.
     #
     # @param value [String] The delimiter to use.
+    # @return [void]
     def runtime_setting_delimiter=(value)
       Configuration.runtime_setting_delimiter = value.to_s
     end
@@ -162,6 +166,9 @@ module UltraSettings
     # Set the object to use for runtime settings. This can be any object that
     # responds to the [] method. If you are using the `super_settings` gem,
     # you can set this to `SuperSettings`.
+    #
+    # @param value [#[]] The object to use for runtime settings.
+    # @return [void]
     attr_writer :runtime_settings
 
     # Get the object to use for runtime settings.
@@ -176,21 +183,46 @@ module UltraSettings
     # URL will be displayed in the web view for fields that support runtime settings.
     # The URL may contain a `${name}` placeholder that will be replaced with the name
     # of the setting.
+    #
+    # @param value [String] The URL for changing runtime settings.
+    # @return [void]
     attr_writer :runtime_settings_url
 
     # Get the URL for changing runtime settings.
     #
     # @param name [String] The name of the setting.
+    # @param type [String] The type of the setting.
+    # @param description [String] The description of the setting.
     # @return [String, nil]
     # @api private
-    def runtime_settings_url(name, type)
+    def runtime_settings_url(name: nil, type: nil, description: nil)
       url = @runtime_settings_url.to_s
       return nil if url.empty?
 
-      url = url.gsub("${name}", URI.encode_www_form_component(name.to_s))
-      url.gsub("${type}", URI.encode_www_form_component(type.to_s))
+      url.gsub("${name}", URI.encode_www_form_component(name.to_s))
+        .gsub("${type}", URI.encode_www_form_component(type.to_s))
+        .gsub("${description}", URI.encode_www_form_component(description.to_s))
+    end
+
+    # Set whether or not the runtime settings engine is considered secure. If this is set
+    # to false, then runtime settings will be disabled for all fields marked as secret.
+    # The default value is true.
+    #
+    # @param value [Boolean] Whether the runtime settings engine is secure.
+    # @return [void]
+    attr_writer :runtime_settings_secure
+
+    # Check if the runtime settings engine is considered secure.
+    #
+    # @return [Boolean]
+    def runtime_settings_secure?
+      @runtime_settings_secure
     end
 
+    # Set whether fields should be considered secret by default.
+    #
+    # @param value [Boolean] Whether fields should be secret by default.
+    # @return [void]
     def fields_secret_by_default=(value)
       Configuration.fields_secret_by_default = value
     end
@@ -228,6 +260,19 @@ module UltraSettings
       @configurations.keys
     end
 
+    # Get an array of all of the configuration instances that have been loaded into memory.
+    #
+    # @return [Array<UltraSettings::Configuration>] The configuration instances.
+    # @api private
+    def __configurations__
+      @configurations.each do |name, class_name|
+        __load_config__(name, class_name)
+      end
+
+      config_classes = ObjectSpace.each_object(Class).select { |klass| klass < Configuration }
+      config_classes.collect(&:instance)
+    end
+
     private
 
     # Load a configuration class.
@@ -245,6 +290,7 @@ module UltraSettings
           unless klass < Configuration
             raise TypeError.new("Configuration class #{class_name} does not inherit from UltraSettings::Configuration")
           end
+
           @configurations[name] = klass
         end
       end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ultra_settings
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,7 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -36,6 +34,9 @@ files:
 - MIT-LICENSE.txt
 - README.md
 - VERSION
+- app/_config_description.html.erb
+- app/_config_list.html.erb
+- app/_select_menu.html.erb
 - app/application.css
 - app/application.js
 - app/application_vars.css.erb
@@ -53,6 +54,7 @@ files:
 - lib/ultra_settings/field.rb
 - lib/ultra_settings/rack_app.rb
 - lib/ultra_settings/railtie.rb
+- lib/ultra_settings/render_helper.rb
 - lib/ultra_settings/uninitialized_runtime_settings.rb
 - lib/ultra_settings/version.rb
 - lib/ultra_settings/view_helper.rb
@@ -66,7 +68,6 @@ metadata:
   homepage_uri: https://github.com/bdurand/ultra_settings
   source_code_uri: https://github.com/bdurand/ultra_settings
   changelog_uri: https://github.com/bdurand/ultra_settings/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: UltraSettings is a Ruby gem that provides a flexible and documented approach
   to managing application configurations from multiple sources, including environment