ultra_settings 2.8.0 → 2.9.0

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UltraSettings
-  VERSION = File.read(File.join(__dir__, "..", "..", "VERSION")).strip
+  VERSION = File.read(File.expand_path("../../VERSION", __dir__)).strip.freeze
 end

data/lib/ultra_settings/web_view.rb

@@ -3,6 +3,8 @@
 module UltraSettings
   # Helper class for rendering the settings information in an HTML page.
   class WebView
+    include RenderHelper
+
     attr_reader :layout_css
 
     # Initialize a new WebView with the specified color scheme.
@@ -17,8 +19,13 @@ module UltraSettings
 
     # Render the complete settings page HTML.
     #
+    # @param request [Rack::Request, nil] The current Rack request for access control.
+    # @param locale [String] The locale code for translations.
     # @return [String] The rendered HTML page.
-    def render_settings
+    def render_settings(request = nil, locale: UltraSettings::MiniI18n::DEFAULT_LOCALE)
+      @request = request
+      @locale = locale
+      refresh_super_settings!
       @layout_template.result(binding)
     end
 
@@ -26,7 +33,25 @@ module UltraSettings
     #
     # @return [String] The HTML content for the settings.
     def content
-      UltraSettings::ApplicationView.new(color_scheme: @color_scheme).render
+      UltraSettings::ApplicationView.new(
+        color_scheme: @color_scheme,
+        locale: @locale || UltraSettings::MiniI18n::DEFAULT_LOCALE
+      ).render
+    end
+
+    # Look up a translation key for the current locale.
+    #
+    # @param key [String] dotted translation key
+    # @return [String]
+    def t(key)
+      UltraSettings::MiniI18n.t(key, locale: @locale || UltraSettings::MiniI18n::DEFAULT_LOCALE)
+    end
+
+    # Return the text direction (+"ltr"+ or +"rtl"+) for the current locale.
+    #
+    # @return [String]
+    def text_direction
+      UltraSettings::MiniI18n.text_direction(@locale || UltraSettings::MiniI18n::DEFAULT_LOCALE)
     end
 
     private
@@ -36,5 +61,11 @@ module UltraSettings
       css = ViewHelper.read_app_file("layout.css")
       "#{vars}\n#{css}"
     end
+
+    def refresh_super_settings!
+      return unless defined?(SuperSettings) && UltraSettings.__runtime_settings__ == SuperSettings
+
+      SuperSettings.refresh_settings
+    end
   end
 end

data/lib/ultra_settings.rb

@@ -8,24 +8,6 @@ require "singleton"
 require "digest"
 require "uri"
 
-require_relative "ultra_settings/configuration"
-require_relative "ultra_settings/coerce"
-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"
-require_relative "ultra_settings/uninitialized_runtime_settings"
-require_relative "ultra_settings/yaml_config"
-require_relative "ultra_settings/version"
-
-if defined?(Rails::Railtie)
-  require_relative "ultra_settings/railtie"
-end
-
 # This is the root namespace for UltraSettings. You can add configurations to
 # this namespace using the add method.
 #
@@ -33,13 +15,29 @@ end
 #   UltraSettings.add(:test)
 #   UltraSettings.test # => TestConfiguration.instance
 module UltraSettings
-  VALID_NAME__PATTERN = /\A[a-z_][a-zA-Z0-9_]*\z/
+  autoload :Configuration, File.join(__dir__, "ultra_settings/configuration")
+  autoload :Coerce, File.join(__dir__, "ultra_settings/coerce")
+  autoload :ConfigHelper, File.join(__dir__, "ultra_settings/config_helper")
+  autoload :Field, File.join(__dir__, "ultra_settings/field")
+  autoload :MiniI18n, File.join(__dir__, "ultra_settings/mini_i18n")
+  autoload :RackApp, File.join(__dir__, "ultra_settings/rack_app")
+  autoload :ViewHelper, File.join(__dir__, "ultra_settings/view_helper")
+  autoload :RenderHelper, File.join(__dir__, "ultra_settings/render_helper")
+  autoload :WebView, File.join(__dir__, "ultra_settings/web_view")
+  autoload :ApplicationView, File.join(__dir__, "ultra_settings/application_view")
+  autoload :ConfigurationView, File.join(__dir__, "ultra_settings/configuration_view")
+  autoload :UninitializedRuntimeSettings, File.join(__dir__, "ultra_settings/uninitialized_runtime_settings")
+  autoload :YamlConfig, File.join(__dir__, "ultra_settings/yaml_config")
+  autoload :VERSION, File.join(__dir__, "ultra_settings/version")
+
+  VALID_NAME_PATTERN = /\A[a-z_][a-zA-Z0-9_]*\z/
 
   @configurations = {}
   @mutex = Mutex.new
   @runtime_settings = nil
   @runtime_settings_url = nil
   @runtime_settings_secure = true
+  @super_settings_api_path = nil
 
   class << self
     # Adds a configuration to the root namespace. The configuration will be
@@ -52,7 +50,7 @@ module UltraSettings
     # @return [void]
     def add(name, klass = nil)
       name = name.to_s
-      unless name.match?(VALID_NAME__PATTERN)
+      unless name.match?(VALID_NAME_PATTERN)
         raise ArgumentError.new("Invalid configuration name: #{name.inspect}")
       end
 
@@ -219,6 +217,38 @@ module UltraSettings
       @runtime_settings_secure
     end
 
+    # Set the URL path where the SuperSettings API is mounted. When this is set,
+    # the web UI will check the SuperSettings API at this path for edit access
+    # and load the SuperSettings api.js client library to enable inline editing
+    # of runtime settings.
+    #
+    # The path must be a relative URL path starting with "/". Authorization is
+    # handled entirely by SuperSettings — the browser makes a GET request to
+    # the /authorized endpoint to check access and all API calls go directly
+    # to the SuperSettings endpoint.
+    #
+    # @param value [String, nil] The relative URL path where SuperSettings is mounted.
+    # @return [void]
+    def super_settings_api_path=(value)
+      raise "super_settings gem is required for super_settings_api_path" unless defined?(::SuperSettings)
+
+      if value.nil?
+        @super_settings_api_path = nil
+        return
+      end
+
+      value = value.to_s
+      raise ArgumentError, "super_settings_api_path must be a relative URL path starting with '/'" unless value.start_with?("/")
+
+      @super_settings_api_path = value.chomp("/")
+      self.runtime_settings = ::SuperSettings
+    end
+
+    # Get the URL path where the SuperSettings API is mounted.
+    #
+    # @return [String, nil]
+    attr_reader :super_settings_api_path
+
     # Set whether fields should be considered secret by default.
     #
     # @param value [Boolean] Whether fields should be secret by default.
@@ -304,14 +334,18 @@ module UltraSettings
       if name.respond_to?(:classify)
         name.classify
       else
-        name.split("_").map(&:capitalize).join.gsub("/", "::")
+        name.to_s.split("_").map(&:capitalize).join.gsub("/", "::")
       end
     end
 
     def constantize(class_name)
-      class_name.split("::").reduce(Object) do |mod, name|
+      class_name.to_s.split("::").reduce(Object) do |mod, name|
         mod.const_get(name)
       end
     end
   end
 end
+
+if defined?(Rails::Railtie)
+  require_relative "ultra_settings/railtie"
+end

data/ultra_settings.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   ignore_files = %w[
     .
+    AGENTS.md
     Appraisals
     Gemfile
     Gemfile.lock
@@ -28,6 +29,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultra_settings
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Brian Durand
@@ -34,9 +34,10 @@ files:
 - MIT-LICENSE.txt
 - README.md
 - VERSION
+- app/AGENTS.md
 - app/_config_description.html.erb
 - app/_config_list.html.erb
-- app/_select_menu.html.erb
+- app/_data_source.html.erb
 - app/application.css
 - app/application.js
 - app/application_vars.css.erb
@@ -45,16 +46,50 @@ files:
 - app/layout.css
 - app/layout.html.erb
 - app/layout_vars.css.erb
+- app/locales/ar.json
+- app/locales/cs.json
+- app/locales/da.json
+- app/locales/de.json
+- app/locales/el.json
+- app/locales/en.json
+- app/locales/es.json
+- app/locales/fa.json
+- app/locales/fr.json
+- app/locales/gd.json
+- app/locales/he.json
+- app/locales/hi.json
+- app/locales/it.json
+- app/locales/ja.json
+- app/locales/ko.json
+- app/locales/lt.json
+- app/locales/nb.json
+- app/locales/nl.json
+- app/locales/pl.json
+- app/locales/pt-br.json
+- app/locales/pt.json
+- app/locales/ru.json
+- app/locales/sv.json
+- app/locales/ta.json
+- app/locales/tr.json
+- app/locales/uk.json
+- app/locales/ur.json
+- app/locales/vi.json
+- app/locales/zh-cn.json
+- app/locales/zh-tw.json
 - 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
 - lib/ultra_settings/configuration_view.rb
 - lib/ultra_settings/field.rb
+- lib/ultra_settings/mini_i18n.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
@@ -82,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+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

data/app/_select_menu.html.erb

@@ -1,53 +0,0 @@
-<div class="ultra-settings-dropdown" id="config-dropdown">
-  <button
-    type="button"
-    class="ultra-settings-dropdown-button"
-    id="config-dropdown-button"
-  >
-    Select Configuration
-  </button>
-
-  <div
-    class="ultra-settings-dropdown-menu"
-    id="config-dropdown-menu"
-    style="display: none;"
-  >
-    <div class="ultra-settings-search-container">
-      <input
-        type="text"
-        id="config-search"
-        placeholder="Search..."
-        autocomplete="off"
-      >
-    </div>
-
-    <ul class="ultra-settings-dropdown-list" id="config-list">
-      <% configurations.each do |config| %>
-        <% config_text = [
-            config.class.name,
-            config.class.description
-          ]
-          config.class.fields.each do |field|
-            config_text << field.name
-            config_text << field.description
-            config_text << field.env_var
-            config_text << field.runtime_setting
-          end
-          search_text = config_text.compact.join(" ").downcase %>
-
-        <li
-          class="ultra-settings-dropdown-item"
-          data-value="config-<%= html_escape(config.class.name) %>"
-          data-label="<%= html_escape(config.class.name) %>"
-          data-search="<%= html_escape(search_text) %>"
-        >
-          <span class="ultra-settings-check-icon"></span>
-
-          <span class="ultra-settings-config-name">
-            <%= html_escape(config.class.name) %>
-          </span>
-        </li>
-      <% end %>
-    </ul>
-  </div>
-</div>