ultra_settings 2.8.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6db7d9c5a607d4c0318190ba8357f0577f9d542d08fbc77e6253e3776372476
-  data.tar.gz: 52171f7843724be2e867f2cf3547b934a530249173f8f2c583548f442f9ceb22
+  metadata.gz: d7b197136c21486ad05e4477bba4f7c0b9765dd3e073421ecfc327b3ed16f8bb
+  data.tar.gz: af08178f5b3b47ccab7f7b7aaafba64bbf606759774fe8fdf4054d91be72b52e
 SHA512:
-  metadata.gz: 660219db715918d464d403064ac96920dde3acf7be57e85b3de921ecc7fe4b3ef641f9ef8b386ea931a603ad7cfab5f4f9ddd9cbc4f151226e4d3359d5a25dce
-  data.tar.gz: b4b40f05c524a3bd75fbb237c631e4643f229c50134fadf819acd1dded92855ebb3070eeaa8ee508a36bdbb13ec759a3fd6eb9c140db90d092ebd649a88bb8cf
+  metadata.gz: dde91f729527a598d414a162011b4d296884d9253d1616d7b38d0aa3f419f93666a7852ac7e9422ecd453e3e2629dc376584e1fa4e46955a33b36927d7567028
+  data.tar.gz: db199c5cdb6945b13557641dee89d3ee9ae154632a38b3719d6fcd6c0614ad4b7c07a87e24144567c3363515febb7249b08786acfc76fe9dbf2338757573e381

data/CHANGELOG.md

@@ -1,16 +1,31 @@
-# Changelog
+  # Changelog
 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.9.0
+
+### Added
+
+- Significant redesign of the web UI with a cleaner, more modern layout.
+- Internationalized the web UI with translations into 29 languages. The locale is detected from the browser's `Accept-Language` header.
+- Added support for inline editing of SuperSettings runtime settings directly from the web UI. Set `UltraSettings.super_settings_api_path` to the path where the SuperSettings API is mounted to enable this feature. Authorization is delegated entirely to the SuperSettings API.
+- Added `config_alias` option to `ConfigHelper.configuration_class` to allow a class that includes `ConfigHelper` to reference the configuration with a custom method name instead of the default `config`.
+- Switched to `autoload` for lazy loading of internal classes to improve load time when only a subset of the gem's features are used.
+
+### Fixed
+
+- Static fields are no longer shown as having a runtime settings source in the web UI.
+- Fixed a bug where calling `return nil?` instead of `return nil` could cause an error when a configuration file is not set.
+
 ## 2.8.1
 
 ### Added
 
 - Improved web UI indication for which data sources on fields have been overridden by data sources with higher precedence.
 - Added rake tasks for auditing configuration data sources.
-- A companion gem `yard-ultra_settings` is now available to provide YARD integration for documenting UltraSettings configuration classes. See the [yard-ultra_settings](https://github.com/bdurand/ultra_settings/yard_plugin) gem for more information.
+- A companion gem `yard-ultra_settings` is now available to provide YARD integration for documenting UltraSettings configuration classes. See the [yard-ultra_settings](https://github.com/bdurand/ultra_settings/tree/main/yard_plugin) gem for more information.
 
 ## 2.8.0
 

data/README.md

@@ -417,7 +417,7 @@ You can specify the color scheme by setting by providing the `color_scheme` opti
 UltraSettings::RackApp.new(color_scheme: :dark)
 ```
 
-#### Embedding the Settings View in Admin Tools
+#### Embedding Into Application Views
 
 If you prefer to embed the settings view directly into your own admin tools or dashboard, you can use the `UltraSettings::ApplicationView` class to render the settings interface within your existing views:
 
@@ -445,6 +445,45 @@ You'll also need to include the CSS for the configuration view on your page.
 </head>
 ```
 
+#### Customizing The Web UI
+
+You can specify the color scheme by setting by providing the `color_scheme` option to the `UltraSettings::ApplicationView` constructor. The default color scheme is `:light`. You can also set the scheme to `:dark` or `:system`.
+
+```ruby
+UltraSettings::ApplicationView.new(color_scheme: :dark)
+```
+
+You can specify the language to render the application in with the `locale` option to the `UltraSettings::ApplicationView` constructor. The default language is English but it can be changed to any language that has a corresponding JSON file in the `app/locales` directory.
+
+```ruby
+UltraSettings::ApplicationView.new(locale: "es").render
+```
+
+#### Inline Editing With SuperSettings
+
+If you are using the [super_settings](https://github.com/bdurand/super_settings) gem for runtime settings, you can enable inline editing of runtime settings directly in the web UI. This adds edit buttons next to runtime settings fields that open a panel for creating or updating settings through the SuperSettings API.
+
+To enable editing, set `super_settings_api_path` to the relative URL path where the SuperSettings API is mounted:
+
+```ruby
+UltraSettings.super_settings_api_path = "/super_settings"
+```
+
+This will automatically set `SuperSettings` as the runtime settings store. The web UI will check the SuperSettings API for edit access on page load by making a HEAD request. If the current user has read-write access (as determined by the SuperSettings authorization layer), edit buttons will appear next to runtime settings fields.
+
+All authorization is handled by the SuperSettings API — the same permissions that control the SuperSettings web UI will apply to inline editing in UltraSettings. Configure access control in your `SuperSettings::RackApplication` or Rails controller as usual.
+
+> [!IMPORTANT]
+> You will need to have the SuperSettings API mounted and properly locked down with authentication. If the API is not accessible, then the edit buttons will not be shown. Check the browser console for any errors if you expect the buttons to be shown but they are not appearing.
+
+##### Embedding with Edit Support
+
+When embedding the settings view using `UltraSettings::ApplicationView`, you can pass the `super_settings_api_path` option to enable the inline editing UI:
+
+```erb
+<%= UltraSettings::ApplicationView.new(super_settings_api_path: "/super_settings").render %>
+```
+
 ### Testing With UltraSettings
 
 When writing automated tests, you may need to override configuration settings to test different scenarios. UltraSettings provides the `UltraSettings.override!` method to temporarily change settings within a test block. Below are examples of how to override the `TestConfiguration#foo` value in a test.

data/VERSION

@@ -1 +1 @@
-2.8.1
+2.9.0

data/app/AGENTS.md

@@ -0,0 +1,7 @@
+# Web UI
+
+The Web UI is a built-in interface for viewing and editing settings. It is implemented as a Rack application that can be mounted within your existing app or run standalone.
+
+The interface is designed so that it can either be used stand alone or embedded within an existing application's layout.
+
+All strings diplayed in the UI should referenced using the lightweight translation system and added to all the JSON files in app/locales.

data/app/_config_description.html.erb

@@ -1,30 +1,27 @@
 <% config_class = configuration.class
   has_config_file = config_class.configuration_file.is_a?(Pathname) && config_class.fields.any?(&:yaml_key) %>
 
-<% if config_class.description || has_config_file %>
-  <div class="ultra-settings-description-container">
-    <% if config_class.description %>
-      <div class="ultra-settings-description">
-        <%= html_escape(config_class.description).gsub("\n", "<br>") %>
-      </div>
-    <% end %>
+<div class="ultra-settings-config-header">
+  <div class="ultra-settings-config-title"><%= html_escape(config_class.name) %></div>
 
-    <% if has_config_file %>
-      <div class="ultra-settings-description">
-        <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>
+  <% if config_class.description %>
+    <div class="ultra-settings-config-desc">
+      <%= html_escape(config_class.description).gsub("\n", "<br>") %>
+    </div>
+  <% end %>
 
-        <% unless configuration.class.configuration_file&.exist? %>
-          <span class="ultra-settings-file-not-found">
-            (file does not exist)
-          </span>
-        <% end %>
-      </div>
-    <% end %>
-  </div>
-<% end %>
+  <% if has_config_file %>
+    <div class="ultra-settings-config-file">
+      <% if configuration.class.configuration_file&.exist? %>
+        <%= file_icon %>
+        <code><%= html_escape(relative_path(configuration.class.configuration_file)) %></code>
+      <% else %>
+        <span class="ultra-settings-warn">
+          <%= warning_icon(13) %>
+          <code><%= html_escape(relative_path(configuration.class.configuration_file)) %></code>
+          <%= t('config.file_not_found') %>
+        </span>
+      <% end %>
+    </div>
+  <% end %>
+</div>

data/app/_config_list.html.erb

@@ -1,14 +1,2 @@
-<div class="ultra-settings-configuration-list" style="display:none;">
-  <% configurations.each do |configuration| %>
-    <div class="ultra-settings-configuration-summary">
-      <a
-        href="#<%= html_escape(configuration.class.name) %>"
-        class="ultra-settings-configuration-title"
-      >
-        <%= html_escape(configuration.class.name) %>
-      </a>
-
-      <p><%= html_escape(configuration.class.description) %></p>
-    </div>
-  <% end %>
-</div>
+<%# This partial is no longer used by the Slate design.
+   All configurations are visible at once in the main content area. %>

data/app/_data_source.html.erb

@@ -1,39 +1,53 @@
 <% source_value = configuration.__value_from_source__(field.name, source) %>
-<% overridden_by = source_overridden_by(source, current_source) %>
-<div class="ultra-settings-source <%= 'ultra-settings-source-active' if current_source == source %> <%= 'ultra-settings-source-overridden' if overridden_by && !source_value.nil? %>">
-  <span class="ultra-settings-source-type">
-    <%= source_type %>
-  </span>
+<% source_label = source_chip_label(source) %>
+<% chip_class = source_chip_class(source) %>
+<% source_name = source_key_name(field, source) %>
+<div class="ultra-settings-source-row<%= ' active' if current_source == source %>">
+  <span class="ultra-settings-source-chip <%= chip_class %>"><%= source_label %></span>
 
-  <div class="ultra-settings-source-value-container">
-    <% if source_name %>
-      <code class="ultra-settings-source-value">
-        <%= source_name %>
-      </code>
-    <% end %>
-
-    <%= show_defined_value(source_name, source_value, field.secret?) %>
-  </div>
+  <% if source_name %>
+    <span class="ultra-settings-source-key"><%= html_escape(source_name) %></span>
+    <span class="ultra-settings-source-eq">=</span>
+  <% end %>
 
-  <% if current_source == source %>
-    <span class="ultra-settings-source-indicator">
-      Currently active
-    </span>
-  <% elsif overridden_by && !source_value.nil? %>
-    <%= override_indicator(overridden_by) %>
+  <% if source_value.nil? %>
+    <span class="ultra-settings-source-val not-set"><%= t('field.not_set') %></span>
+  <% elsif field.secret? %>
+    <span class="ultra-settings-source-val secret"><%= html_escape(secret_value(source_value)) %></span>
+  <% else %>
+    <span class="ultra-settings-source-val"><%= html_escape(display_value(source_value)) %></span>
   <% end %>
 
   <% if source == :settings %>
-    <% 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) %>"
+    <% if defined?(super_settings_api_path) && super_settings_api_path %>
+      <button
+        type="button"
+        class="ultra-settings-edit-link ultra-settings-ss-edit-btn"
+        style="display:none"
+        title="<%= html_escape(t('config.edit_tooltip').gsub('${name}', field.runtime_setting)) %>"
+        data-ss-key="<%= html_escape(field.runtime_setting) %>"
+        data-ss-default-type="<%= html_escape(super_settings_value_type(field.type)) %>"
+        data-ss-default-description="<%= html_escape(field.description) %>"
       >
-        <%= edit_icon %>
-      </a>
+        <%= edit_icon(13) %>
+      </button>
+    <% else %>
+      <% 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="<%= html_escape(t('config.edit_tooltip').gsub('${name}', field.runtime_setting)) %>"
+        >
+          <%= edit_icon(13) %>
+        </a>
+      <% end %>
     <% end %>
   <% end %>
+
+  <% if current_source == source %>
+    <span class="ultra-settings-source-badge ultra-settings-sb-active"><%= t('source.active') %></span>
+  <% elsif source_overridden_by(source, current_source) && !source_value.nil? %>
+    <span class="ultra-settings-source-badge ultra-settings-sb-overridden"><%= t('source.overridden') %></span>
+  <% end %>
 </div>