ultra_settings 2.7.0 → 2.8.1

data/lib/ultra_settings/tasks/audit_data_sources.rake

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+namespace :ultra_settings do
+  desc <<~DOC
+    Generates a report of environment variables used in configurations that are set to their default values.
+    This report can help identify environment variables that are superfluous and can be removed. It skips any
+    environment variables that are used for secrets.
+  DOC
+  task unnecessary_env_vars: :environment do
+    require_relative "utils"
+    require_relative "../audit_data_sources"
+
+    UltraSettings::Tasks::Utils.eager_load!
+    env_vars_at_default = UltraSettings::AuditDataSources.unnecessary_env_vars
+
+    output = env_vars_at_default.collect do |env_var, value|
+      "Environment variable #{env_var} is set to its default value: #{value.inspect}"
+    end
+    puts output
+  end
+
+  desc <<~DOC
+    Generates a report of runtime settings used in configurations that are set to their default values.
+    This report can help identify runtime settings that are superfluous and can be removed. It skips any
+    runtime settings that are used for secrets.
+  DOC
+  task unnecessary_runtime_settings: :environment do
+    require_relative "utils"
+    require_relative "../audit_data_sources"
+
+    UltraSettings::Tasks::Utils.eager_load!
+    unnecessary_runtime_settings = UltraSettings::AuditDataSources.unnecessary_runtime_settings
+
+    output = unnecessary_runtime_settings.collect do |runtime_setting, value|
+      "Runtime setting #{runtime_setting} is set to its default value: #{value.inspect}"
+    end
+    puts output
+  end
+
+  desc <<~DOC
+    Generates a report of environment variables used in configurations that can be converted to runtime settings.
+    This report can help identify environment variables that can be removed if the corresponding runtime settings
+    are set. It skips any environment variables that are used for secrets.
+  DOC
+  task env_vars_can_be_runtime_setting: :environment do
+    require_relative "utils"
+    require_relative "../audit_data_sources"
+
+    UltraSettings::Tasks::Utils.eager_load!
+    env_vars_can_be_runtime = UltraSettings::AuditDataSources.env_vars_can_be_runtime_setting
+
+    output = env_vars_can_be_runtime.collect do |env_var, runtime_setting, value|
+      "Environment variable #{env_var} can be converted to runtime setting #{runtime_setting} with value: #{value.inspect}"
+    end
+    puts output
+  end
+
+  desc <<~DOC
+    Generates a report of environment variables used in configurations that do not have a default value.
+    This report can help identify settings that could be set in YAML or with a default value rather than via
+    environment variables. If these changes are made, then the environment variables could be removed.
+    It skips any environment variables that are used for secrets.
+  DOC
+  task env_vars_without_default: :environment do
+    require_relative "utils"
+    require_relative "../audit_data_sources"
+
+    UltraSettings::Tasks::Utils.eager_load!
+    env_vars_without_default = UltraSettings::AuditDataSources.env_vars_without_default
+
+    output = env_vars_without_default.collect do |config, field, env_var, value|
+      "Environment variable #{env_var} used by #{config}##{field} does not have a default value (current value: #{value.inspect})"
+    end
+    puts output
+  end
+end

data/lib/ultra_settings/tasks/utils.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module UltraSettings
+  module Tasks
+    module Utils
+      class << self
+        # Helper for eager loading a Rails application.
+        def eager_load!
+          return unless defined?(Rails.application.config.eager_load)
+          return if Rails.application.config.eager_load
+
+          if defined?(Rails.application.eager_load!)
+            Rails.application.eager_load!
+          elsif defined?(Rails.autoloaders.zeitwerk_enabled?) && Rails.autoloaders.zeitwerk_enabled?
+            Rails.autoloaders.each(&:eager_load)
+          else
+            raise "Failed to eager load application."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ultra_settings/view_helper.rb

@@ -11,6 +11,7 @@ module UltraSettings
       # @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
 
@@ -19,6 +20,7 @@ module UltraSettings
       # @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
 
@@ -28,6 +30,12 @@ module UltraSettings
       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.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"
@@ -259,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.

data/ultra_settings.gemspec

@@ -28,6 +28,8 @@ Gem::Specification.new do |spec|
     bin/
     gemfiles/
     spec/
+    test_app/
+    yard_plugin/
   ]
   spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ultra_settings
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,18 +23,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - bbdurand@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- AGENTS.md
 - ARCHITECTURE.md
 - CHANGELOG.md
 - MIT-LICENSE.txt
 - README.md
 - VERSION
+- app/_config_description.html.erb
+- app/_config_list.html.erb
+- app/_data_source.html.erb
+- app/_select_menu.html.erb
 - app/application.css
 - app/application.js
 - app/application_vars.css.erb
@@ -46,6 +49,7 @@ files:
 - app/layout_vars.css.erb
 - lib/ultra_settings.rb
 - lib/ultra_settings/application_view.rb
+- lib/ultra_settings/audit_data_sources.rb
 - lib/ultra_settings/coerce.rb
 - lib/ultra_settings/config_helper.rb
 - lib/ultra_settings/configuration.rb
@@ -53,6 +57,9 @@ 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/tasks/audit_data_sources.rake
+- lib/ultra_settings/tasks/utils.rb
 - lib/ultra_settings/uninitialized_runtime_settings.rb
 - lib/ultra_settings/version.rb
 - lib/ultra_settings/view_helper.rb
@@ -66,7 +73,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 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.3
 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