ultra_settings 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35efcdf391347182451bb26d3740e3d18c6e8c5bb4ff4d0100d0f418bb2eef7c
-  data.tar.gz: ed5721d08d451893fbce63317d92d024a7f2cff1e0c68616455b3343b62eb7a6
+  metadata.gz: 2a9fddef64ed0564d8ead06ae79465a37fdb50a55407139cacc121714475ac6f
+  data.tar.gz: a26020c7d81154d3e000bba327e3a6cb53ab00ae9847ed2f96999ff18d431241
 SHA512:
-  metadata.gz: 4636930f294c4c28389da0ed2e627554b1128a92f7fd622a0ac6eb905e6295ae46c513c449a3552e548b840a24d1c05ea106d32a8896a603ce98c596b0d72313
-  data.tar.gz: f8aa279a14715cc6a5a170d43dbaa1e38a55104b92dd25c403fb3b24b4066048bdb69159bf54cf9a3fb44a4280ccd91dba524ddbdca783eabca678ac5f28460e
+  metadata.gz: 066b922fcc7232a33eee6e6b52924d1efc51d3a4e500f4680f8e03a1feb7a6414a22b55f9b5672e35db7aeb958566fc1685ba39fed8a9f568840af2b60a7b3e2
+  data.tar.gz: b95942f92c5010decb55da413fdd2c9f070ebafef2815ab5bd4f781f803b744c502b98598fc14b4e5338ec7026fd7a1c5b11011136afe4507a0eeb436dac632b

data/CHANGELOG.md

@@ -4,6 +4,22 @@ 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.3.0
+
+### Added
+
+- Added logic for parsing arrays from environment variables. Array fields can now be set as comma delimited strings in an environment variable.
+
+### Fixed
+
+- Mixed case boolean values are now handled properly so that "False" is interpreted as `false` and "True" is interpreted as `true`.
+
+## 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:
@@ -82,13 +100,13 @@ You can customize the behavior of each field using various options:
 
 - `:type` -  Specifies the type of the field. The value of the setting will be cast to this type. If the value in the data source cannot be cast to the data type, then it will not be used. Supported types are:
 
-  - `:string` (the default)
+  - `:string` - This is the default type.
   - `:integer`
   - `:float`
-  - `:boolean` (will accept case insensitive strings "true", "false", "1", "0", "t", "f", "yes", "no", "y", "n")
-  - `:datetime`
+  - `:boolean` - Will accept case insensitive strings "true", "false", "1", "0", "t", "f", "yes", "no", "y", "n".
+  - `:datetime` - Values should be specified in ISO 8601 format.
   - `:symbol`
-  - `:array` (of strings)
+  - `:array` - The array type will return an array of strings. If the raw value is a string (i.e. from an environment variable), it will be iterpreted as a comma separated list of values. You can use double quotes to group values that contain commas and backslashes to escape values. Leading and trailing whitespace will be stripped from each value.
 
 - `:description` - Provides a description of the field. This is used for documentation purposes.
 
@@ -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.3.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/coerce.rb

@@ -10,11 +10,8 @@ module UltraSettings
       false, 0,
       "0", :"0",
       "f", :f,
-      "F", :F,
       "false", :false,
-      "FALSE", :FALSE,
-      "off", :off,
-      "OFF", :OFF
+      "off", :off
     ]).freeze
     # rubocop:enable Lint/BooleanSymbol
 
@@ -39,7 +36,7 @@ module UltraSettings
         when :datetime
           time(value)
         when :array
-          Array(value).map(&:to_s)
+          array(value).map(&:to_s)
         when :symbol
           value.to_s.to_sym
         when :rollout
@@ -53,14 +50,26 @@ module UltraSettings
         end
       end
 
+      # Cast value of array
+      #
+      # @param value [Object]
+      # @return [Array]
+      def array(value)
+        return [] if blank?(value)
+        return value.collect(&:to_s) if value.is_a?(Array)
+
+        parse_csv_line(value.to_s)
+      end
+
       # Cast variations of booleans (i.e. "true", "false", 1, 0, etc.) to actual boolean objects.
       #
       # @param value [Object]
       # @return [Boolean]
       def boolean(value)
         return nil if blank?(value)
+        return false if value == false
 
-        !FALSE_VALUES.include?(value)
+        !FALSE_VALUES.include?(value.to_s.downcase)
       end
 
       # Cast a value to a Time object.
@@ -104,6 +113,43 @@ module UltraSettings
       def present?(value)
         !blank?(value)
       end
+
+      private
+
+      # Parse a line of CSV data to an array of strings. Elements are separated by commas and
+      # characters can be escaped with a backslash.
+      def parse_csv_line(line)
+        values = []
+        current_value = +""
+        in_quotes = false
+
+        i = 0
+        while i < line.length
+          char = line[i]
+
+          if char == "\\"
+            if i + 1 < line.length
+              current_value << line[i + 1]
+              i += 1
+            else
+              current_value << "\\"
+            end
+          elsif char == '"'
+            in_quotes = !in_quotes
+          elsif char == "," && !in_quotes
+            values << current_value.strip
+            current_value = +""
+          else
+            current_value << char
+          end
+
+          i += 1
+        end
+
+        values << current_value.strip unless current_value.empty?
+
+        values
+      end
     end
   end
 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.3.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-12 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler