ultra_settings 2.3.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a9fddef64ed0564d8ead06ae79465a37fdb50a55407139cacc121714475ac6f
-  data.tar.gz: a26020c7d81154d3e000bba327e3a6cb53ab00ae9847ed2f96999ff18d431241
+  metadata.gz: c4d6c86b8bbf3af68e92cc311d50ba5a10c72479b466047b6789b0bdd5aae566
+  data.tar.gz: af86a79d963a42b66b870706a7e47a025b03b59365b63354faec5003f2839087
 SHA512:
-  metadata.gz: 066b922fcc7232a33eee6e6b52924d1efc51d3a4e500f4680f8e03a1feb7a6414a22b55f9b5672e35db7aeb958566fc1685ba39fed8a9f568840af2b60a7b3e2
-  data.tar.gz: b95942f92c5010decb55da413fdd2c9f070ebafef2815ab5bd4f781f803b744c502b98598fc14b4e5338ec7026fd7a1c5b11011136afe4507a0eeb436dac632b
+  metadata.gz: 106b3a42b408d389b59b759e9639f38ae10a538aec7046d37d496373483a33174a2505bc44c8c012e14f39a7215358b7863487fbc209f68bce8b132258aa9624
+  data.tar.gz: 5044a165b1129aba0c2678f0e9f9fe53e75516a37f50cc76d2c134850f37e38e81d56d53864ba980c3cbd36c704141f0a7434e371eb7210bef0d4f601640611c

data/CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.4.1
+
+### Changed
+
+- Ignore base configuration classes that don't have any fields defined in the web UI.
+- Allow overriding values on static fields in tests.
+- Changed Web UI CSS variable scope to apply to all application elements.
+
+## 2.4.0
+
+### Added
+
+- Added the `UltraSettings::ConfigHelper` module to add convenience methods `config` on the class and instance.
+
 ## 2.3.0
 
 ### Added

data/README.md

@@ -324,24 +324,40 @@ end
 Rails.application.settings.my_service.host
 ```
 
-#### Using a Helper Method
-
-To keep your codebase clean, especially if most configurations are accessed from within a specific class, you can encapsulate the configuration access in a helper method.
+#### Using Helper Methods
 
+To streamline configuration access and keep your codebase clean, especially when configurations are frequently accessed within specific classes, you can encapsulate configuration access in a helper method:
 
 ```ruby
 class MyService
-
-  # Reference the value as `settings.host`
+  def api_key
+    config.api_key
+  end
 
   private
 
-  def settings
+  def config
     MyServiceConfiguration.instance
   end
 end
 ```
 
+#### Leveraging UltraSettings::ConfigHelper
+
+For added convenience, you can use the UltraSettings::ConfigHelper module to automatically generate helper methods for accessing configurations at both the class and instance levels:
+
+```ruby
+class MyService
+
+  extend UltraSettings::ConfigHelper
+  configuration_class MyServiceConfiguration
+
+  # Adds these helper methods:
+  # - MyService.config
+  # - MyService.new.config
+end
+```
+
 ### Web UI
 
 UltraSettings provides a web UI via a mountable Rack application. You can use this to view the settings values and documentation. The UI will not display the value of any setting marked as secret.

data/VERSION

@@ -1 +1 @@
-2.3.0
+2.4.1

data/app/application.css

@@ -62,4 +62,4 @@
   -webkit-appearance: none;
   -moz-appearance: none;
   appearance: none;
-}
+}

data/app/application_vars.css.erb

@@ -1,5 +1,5 @@
 <% unless color_scheme == :dark %>
-  .ultra-settings-configuration {
+  .ultra-settings {
     --table-header-bg-color: #fff;
     --table-border-color: #dee2e6;
     --alt-row-color: rgba(0, 0, 0, .05);
@@ -15,7 +15,7 @@
   @media (prefers-color-scheme: dark) {
 <% end %>
 <% if color_scheme == :system || color_scheme == :dark %>
-  .ultra-settings-configuration {
+  .ultra-settings {
     --table-header-bg-color: #333;
     --table-border-color: #555;
     --alt-row-color: rgba(0, 0, 0, .30);

data/app/index.html.erb

@@ -1,20 +1,26 @@
-<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| %>
-        <option value="config-<%= html_escape(name) %>"><%= html_escape(UltraSettings.send(name).class.name) %></option>
-      <% end %>
-    </select>
-  </form>
-</div>
-
-<% UltraSettings.__configuration_names__.sort.each do |name| %>
-  <% configuration = UltraSettings.send(name) %>
+<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? %>
 
-  <div class="ultra-settings-configuration" id="config-<%= html_escape(name) %>" style="display:none;">
-    <%= UltraSettings::ConfigurationView.new(configuration).render(table_class: table_class) %>
+          <option value="config-<%= html_escape(name) %>"><%= html_escape(UltraSettings.send(name).class.name) %></option>
+        <% end %>
+      </select>
+    </form>
   </div>
-<% end %>
+
+  <% 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>
+  <% end %>
+</div>
 
 <script>
   <%= javascript %>

data/lib/ultra_settings/config_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module UltraSettings
+  # 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
+  module ConfigHelper
+    def configuration_class(config_class)
+      define_singleton_method :config do
+        config_class.instance
+      end
+
+      define_method :config do
+        self.class.config
+      end
+    end
+  end
+end

data/lib/ultra_settings/configuration.rb

@@ -533,11 +533,14 @@ module UltraSettings
       field = self.class.send(:defined_fields)[name]
       return nil unless field
 
-      if field.static? && @ultra_settings_memoized_values.include?(name)
+      use_override = @ultra_settings_override_values[Thread.current.object_id]&.include?(name)
+
+      if field.static? && !use_override && @ultra_settings_memoized_values.include?(name)
         return @ultra_settings_memoized_values[name]
       end
 
-      if @ultra_settings_override_values[Thread.current.object_id]&.include?(name)
+      value = nil
+      if use_override
         value = field.coerce(@ultra_settings_override_values[Thread.current.object_id][name])
       else
         env = ENV if field.env_var
@@ -551,7 +554,7 @@ module UltraSettings
         value = field.default
       end
 
-      if field.static?
+      if field.static? && !use_override
         @ultra_settings_mutex.synchronize do
           if @ultra_settings_memoized_values.include?(name)
             value = @ultra_settings_memoized_values[name]

data/lib/ultra_settings/configuration_view.rb

@@ -68,7 +68,7 @@ module UltraSettings
       else
         "Value: #{display_value(value)}"
       end
-      "<dfn title=\"#{html_escape(title)}\">#{html_escape(label)}</dfn>"
+      "<dfn style=\"text-decoration: underline dotted;\" title=\"#{html_escape(title)}\">#{html_escape(label)}</dfn>"
     end
 
     def secret_value(value)

data/lib/ultra_settings.rb

@@ -10,6 +10,7 @@ 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/web_view"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultra_settings
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-12 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ files:
 - lib/ultra_settings.rb
 - lib/ultra_settings/application_view.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