ultra_settings 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35efcdf391347182451bb26d3740e3d18c6e8c5bb4ff4d0100d0f418bb2eef7c
-  data.tar.gz: ed5721d08d451893fbce63317d92d024a7f2cff1e0c68616455b3343b62eb7a6
+  metadata.gz: a34c970ed06134a778e29f09ef7640a255a82f45bbf74e703963a7d9b911b598
+  data.tar.gz: 8065a6941af25b2d18b0e6617af074443c4de7da24541fad0d062f562a640c4d
 SHA512:
-  metadata.gz: 4636930f294c4c28389da0ed2e627554b1128a92f7fd622a0ac6eb905e6295ae46c513c449a3552e548b840a24d1c05ea106d32a8896a603ce98c596b0d72313
-  data.tar.gz: f8aa279a14715cc6a5a170d43dbaa1e38a55104b92dd25c403fb3b24b4066048bdb69159bf54cf9a3fb44a4280ccd91dba524ddbdca783eabca678ac5f28460e
+  metadata.gz: d740cea45e6d52bf0392f9c867661b24b55f01ed0b3bb557f9730876af973d08036a47197539cee655a584a11b07b3ecb7ffcbd51cf4a6032605c9ab59b9277b
+  data.tar.gz: f11544c978f8b17790d9fe50b5fb03338a680da9dd4e045cc6e45cad2ab5e6910b51c737fd2735052eb835232023707dbd93bb6460627376765c01779c1f099f

data/CHANGELOG.md

@@ -4,6 +4,12 @@ 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.2.0
+
+### Added
+
+- Added option for `UltraSettings.runtime_settings_url` to allow configuring a link for editing runtime settings from the web UI.
+
 ## 2.1.0
 
 ### Added

data/README.md

@@ -10,6 +10,24 @@ UltraSettings is a Ruby gem designed for managing application settings from vari
 
 UltraSettings emphasizes well-documented configuration. You can include documentation directly in the configuration code. The gem also includes a [web UI](#web-ui) that can be mounted as a Rack app or embedded in other views allowing admin users to easily view configuration settings and documentation.
 
+## Table Of Contents
+
+- [Key Features](#key-features)
+- [Usage](#usage)
+  - [Defining Configurations](#defining-configurations)
+  - [Field Options](#field-options)
+  - [Environment Variables](#environment-variables)
+  - [Runtime Settings](#runtime-settings)
+  - [YAML Files](#yaml-files)
+  - [Removing The Hierarchy](#removing-the-hierarchy)
+  - [Accessing Settings](#accessing-settings)
+- [Web UI](#web-ui)
+- [Testing With UltraSettings](#testing-with-ultrasettings)
+- [Rollout Percentages](#rollout-percentages)
+- [Installation](#installation)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Key Features
 
 This gem supports a three-layer hierarchy for defining configuration sources:
@@ -176,6 +194,8 @@ You can customize the behavior of runtime setting names with the following optio
 
 - **Disabling Runtime Settings:** You can disable runtime settings as a default source for fields by setting `runtime_settings_disabled` to `true` in your configuration class. You can disable runtime settings on individual fields by setting `runtime_setting` on the field to `false`.
 
+- **Editing Links** You can specify a URL for editing runtime settings from the web UI by setting `UltraSettings.runtime_settings_url` to the desired URL. This will add links to the runtime settings in the web UI. You can use the placeholder `${name}` in the URL which will be replaced with the name of the runtime setting. If you are using the `super_settings` gem for runtime settings, then you can target a setting by adding `#edit=${name}` to the root URL where `super_settings` is mounted.
+
 If a setting value cannot be loaded from the runtime settings, then it's value will attempt to be loaded from a YAML file.
 
 ### YAML Files
@@ -480,7 +500,7 @@ bundle exec rackup
 You can test with some setting set by setting environment variable used in the test configuration.
 
 ```bash
-MY_SERVICE_HOST=host.example.com MY_SERVICE_TOKEN=secret bundle exec rspec
+MY_SERVICE_HOST=host.example.com MY_SERVICE_TOKEN=secret bundle exec rackup
 ```
 
 You can test dark mode by setting the `COLOR_SCHEME` environment variable.

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.2.0

data/app/configuration.html.erb

@@ -52,14 +52,14 @@
             <% end %>
           </td>
 
-          <td>
+          <td style="word-wrap: break-word;">
             <% unless field.description.to_s.empty? %>
               <div>
                 <%= html_escape(field.description) %>
               </div>
             <% end %>
 
-            <ul style="margin: 0; padding: 0;list-style-type: disc; list-style-position: inside;">
+            <ul style="margin: 0 0 0 1rem; padding: 0; list-style-type: disc; list-style-position: outside;">
               <% if field.env_var && !configuration.class.environment_variables_disabled? %>
                 <li>
                   <% if source == :env %>
@@ -68,9 +68,8 @@
                   <% else %>
                     Can be
                   <% end %>
-                  set with the
+                  set with the environment variable
                   <code><%= show_defined_value(field.env_var, configuration.__value_from_source__(field.name, :env), field.secret?) %></code>
-                  environment variable.
                   <% if source == :env %>
                     </strong>
                   <% end %>
@@ -84,12 +83,21 @@
                   <% else %>
                     Can be
                   <% end %>
-                  set with the
+                  set with the runtime setting
                   <code><%= show_defined_value(field.runtime_setting, configuration.__value_from_source__(field.name, :settings), field.secret?) %></code>
-                  runtime setting.
                   <% if source == :settings %>
                     </strong>
                   <% end %>
+
+                  <% edit_url = UltraSettings.runtime_settings_url(field.runtime_setting) %>
+                  <% if edit_url %>
+                    <a href="<%= html_escape(edit_url) %>" title="Edit <%= html_escape(field.runtime_setting) %>" style="text-decoration: none; color: inherit; vertical-align: middle;">
+                      <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-pencil-square" viewBox="0 0 16 16">
+                        <path d="M15.502 1.94a.5.5 0 0 1 0 .706L14.459 3.69l-2-2L13.502.646a.5.5 0 0 1 .707 0l1.293 1.293zm-1.75 2.456-2-2L4.939 9.21a.5.5 0 0 0-.121.196l-.805 2.414a.25.25 0 0 0 .316.316l2.414-.805a.5.5 0 0 0 .196-.12l6.813-6.814z"/>
+                        <path fill-rule="evenodd" d="M1 13.5A1.5 1.5 0 0 0 2.5 15h11a1.5 1.5 0 0 0 1.5-1.5v-6a.5.5 0 0 0-1 0v6a.5.5 0 0 1-.5.5h-11a.5.5 0 0 1-.5-.5v-11a.5.5 0 0 1 .5-.5H9a.5.5 0 0 0 0-1H2.5A1.5 1.5 0 0 0 1 2.5z"/>
+                      </svg>
+                    </a>
+                  <% end %>
                 </li>
               <% end %>
               <% if field.yaml_key && !configuration.class.yaml_config_disabled? %>
@@ -100,9 +108,8 @@
                   <% else %>
                     Can be
                   <% end %>
-                  set with the
+                  set with the configuration file key
                   <code><%= show_defined_value(field.yaml_key, configuration.__value_from_source__(field.name, :yaml), field.secret?) %></code>
-                  key in the configuration file.
                   <% if source == :yaml %>
                     </strong>
                   <% end %>

data/lib/ultra_settings/configuration.rb

@@ -7,6 +7,9 @@ module UltraSettings
     ALLOWED_NAME_PATTERN = /\A[a-z_][a-zA-Z0-9_]*\z/
     ALLOWED_TYPES = [:string, :symbol, :integer, :float, :boolean, :datetime, :array].freeze
 
+    @env_var_prefix = nil
+    @runtime_setting_prefix = nil
+
     class << self
       # Define a field on the configuration. This will create a getter method for the field.
       # The field value will be read from the environment, runtime settings, or a YAML file
@@ -435,10 +438,10 @@ module UltraSettings
     end
 
     def initialize
-      @mutex = Mutex.new
-      @memoized_values = {}
-      @override_values = {}
-      @yaml_config = nil
+      @ultra_settings_mutex = Mutex.new
+      @ultra_settings_memoized_values = {}
+      @ultra_settings_override_values = {}
+      @ultra_settings_yaml_config = nil
     end
 
     def [](name)
@@ -450,7 +453,7 @@ module UltraSettings
     end
 
     def override!(values, &block)
-      save_val = @override_values[Thread.current.object_id]
+      save_val = @ultra_settings_override_values[Thread.current.object_id]
 
       temp_values = (save_val || {}).dup
       values.each do |key, value|
@@ -458,13 +461,13 @@ module UltraSettings
       end
 
       begin
-        @mutex.synchronize do
-          @override_values[Thread.current.object_id] = temp_values
+        @ultra_settings_mutex.synchronize do
+          @ultra_settings_override_values[Thread.current.object_id] = temp_values
         end
         yield
       ensure
-        @mutex.synchronize do
-          @override_values[Thread.current.object_id] = save_val
+        @ultra_settings_mutex.synchronize do
+          @ultra_settings_override_values[Thread.current.object_id] = save_val
         end
       end
     end
@@ -530,12 +533,12 @@ module UltraSettings
       field = self.class.send(:defined_fields)[name]
       return nil unless field
 
-      if field.static? && @memoized_values.include?(name)
-        return @memoized_values[name]
+      if field.static? && @ultra_settings_memoized_values.include?(name)
+        return @ultra_settings_memoized_values[name]
       end
 
-      if @override_values[Thread.current.object_id]&.include?(name)
-        value = field.coerce(@override_values[Thread.current.object_id][name])
+      if @ultra_settings_override_values[Thread.current.object_id]&.include?(name)
+        value = field.coerce(@ultra_settings_override_values[Thread.current.object_id][name])
       else
         env = ENV if field.env_var
         settings = UltraSettings.__runtime_settings__ if field.runtime_setting
@@ -549,11 +552,11 @@ module UltraSettings
       end
 
       if field.static?
-        @mutex.synchronize do
-          if @memoized_values.include?(name)
-            value = @memoized_values[name]
+        @ultra_settings_mutex.synchronize do
+          if @ultra_settings_memoized_values.include?(name)
+            value = @ultra_settings_memoized_values[name]
           else
-            @memoized_values[name] = value
+            @ultra_settings_memoized_values[name] = value
           end
         end
       end
@@ -578,7 +581,7 @@ module UltraSettings
     end
 
     def __yaml_config__
-      @yaml_config ||= self.class.load_yaml_config || {}
+      @ultra_settings_yaml_config ||= self.class.load_yaml_config || {}
     end
   end
 end

data/lib/ultra_settings.rb

@@ -6,6 +6,7 @@ require "time"
 require "pathname"
 require "singleton"
 require "digest"
+require "uri"
 
 require_relative "ultra_settings/configuration"
 require_relative "ultra_settings/coerce"
@@ -33,6 +34,7 @@ module UltraSettings
   @configurations = {}
   @mutex = Mutex.new
   @runtime_settings = nil
+  @runtime_settings_url = nil
 
   class << self
     # Adds a configuration to the root namespace. The configuration will be
@@ -167,6 +169,24 @@ module UltraSettings
       @runtime_settings
     end
 
+    # Set the URL for changing runtime settings. If this is set, then a link to the
+    # 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.
+    attr_writer :runtime_settings_url
+
+    # Get the URL for changing runtime settings.
+    #
+    # @param name [String] The name of the setting.
+    # @return [String, nil]
+    # @api private
+    def runtime_settings_url(name)
+      url = @runtime_settings_url.to_s
+      return nil if url.empty?
+
+      url.gsub("${name}", URI.encode_www_form_component(name))
+    end
+
     def fields_secret_by_default=(value)
       Configuration.fields_secret_by_default = value
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultra_settings
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-12 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler