ultra_settings 2.9.1 → 2.10.1

data/lib/ultra_settings/configuration_view.rb

@@ -24,13 +24,24 @@ module UltraSettings
 
     # Render the HTML for the configuration view.
     #
+    # The runtime settings cache is reloaded before rendering so that values changed
+    # from the UI are displayed immediately rather than after the runtime settings
+    # engine next refreshes itself. If a page renders more than one view, wrap them all
+    # in `UltraSettings.with_runtime_settings_reloaded` so that the settings are only
+    # reloaded once for the page instead of once per view.
+    #
     # @param table_class [String] @deprecated CSS class for the table element (maintained for backwards compatibility).
     # @return [String] The rendered HTML.
     def render(table_class: "")
-      configuration = @configuration # used by ERB template via binding
-      html = ViewHelper.erb_template("configuration.html.erb").result(binding)
-      html = html.html_safe if html.respond_to?(:html_safe)
-      html
+      UltraSettings.with_runtime_settings_reloaded do
+        # Expose configuration as a local for the ERB template without a direct
+        # assignment, which would emit an unused variable warning under ruby -w.
+        template_binding = binding
+        template_binding.local_variable_set(:configuration, @configuration)
+        html = ViewHelper.erb_template("configuration.html.erb").result(template_binding)
+        html = html.html_safe if html.respond_to?(:html_safe)
+        html
+      end
     end
 
     # Convert the view to a string by rendering it.
@@ -70,6 +81,25 @@ module UltraSettings
       end
     end
 
+    # The text placed on the clipboard by the copy button. This is the raw value
+    # rather than the inspected value shown in the UI so that, for example, copying
+    # a string setting does not include the surrounding quotes.
+    #
+    # @param value [Object] The setting value.
+    # @return [String] The text to copy.
+    def copy_value(value)
+      case value
+      when nil
+        ""
+      when Time
+        value.iso8601
+      when Array
+        value.join("\n")
+      else
+        value.to_s
+      end
+    end
+
     def secret_value(value)
       if value.nil?
         t("field.nil")
@@ -78,13 +108,63 @@ module UltraSettings
       end
     end
 
+    # Shorten a file path for display by making it relative to the working
+    # directory or to the YAML configuration directory. The absolute path is
+    # used if the file is not inside either directory.
+    #
+    # @param path [Pathname] The absolute file path.
+    # @return [String] The path to display.
     def relative_path(path)
-      root_path = Pathname.new(Dir.pwd)
-      config_path = UltraSettings::Configuration.yaml_config_path
-      unless config_path.realpath.to_s.start_with?("#{root_path.realpath}#{File::SEPARATOR}")
-        root_path = config_path
+      paths = display_paths(Pathname.new(path).expand_path)
+      display_path_roots.each do |root|
+        paths.each do |file_path|
+          relative = path_inside(file_path, root)
+          return relative if relative
+        end
       end
-      path.relative_path_from(root_path)
+      paths.first.to_s
+    end
+
+    # The file path in both its literal and symlink resolved forms so that it can
+    # be matched against a directory that is specified in either form.
+    #
+    # @param path [Pathname] The absolute file path.
+    # @return [Array<Pathname>]
+    def display_paths(path)
+      [path, resolved_path(path.dirname)&.join(path.basename)].compact.uniq
+    end
+
+    # Directories that a displayed path can be made relative to, in order of
+    # preference. Directories are listed in both their literal and symlink
+    # resolved forms since a file path can be in either form.
+    #
+    # @return [Array<Pathname>]
+    def display_path_roots
+      roots = [Pathname.new(Dir.pwd)]
+      config_path = UltraSettings::Configuration.yaml_config_path
+      roots << Pathname.new(config_path) if config_path
+      roots.flat_map { |root| [root.expand_path, resolved_path(root)] }.compact.uniq
+    end
+
+    # @param path [Pathname] The absolute file path.
+    # @param root [Pathname] The absolute directory path.
+    # @return [String, nil] The path relative to the directory or nil if it is not inside it.
+    def path_inside(path, root)
+      relative = path.relative_path_from(root).to_s.delete_prefix("./")
+      return nil if relative == "." || relative.start_with?("..")
+
+      relative
+    rescue ArgumentError
+      # relative_path_from raises if the paths have no common root (e.g. different drives).
+      nil
+    end
+
+    # @param path [Pathname] The directory path.
+    # @return [Pathname, nil] The path with symlinks resolved or nil if it does not exist.
+    def resolved_path(path)
+      path.realpath
+    rescue SystemCallError
+      nil
     end
 
     def source_chip_label(source)
@@ -116,6 +196,34 @@ module UltraSettings
       end
     end
 
+    # True if the YAML keys for a configuration are hidden behind a toggle button.
+    # They are hidden by default when the YAML file does not exist since the keys
+    # are not used by the application.
+    #
+    # @param configuration [UltraSettings::Configuration] The configuration instance.
+    # @return [Boolean]
+    def hide_yaml_keys?(configuration)
+      config_class = configuration.class
+      file = config_class.configuration_file
+      file.is_a?(Pathname) && !file.exist? && config_class.fields.any?(&:yaml_key)
+    end
+
+    # Inline script for the button that shows and hides the YAML keys. It is
+    # inlined on the element so that the button also works when the configuration
+    # view is embedded in a host application page that does not include the
+    # bundled JavaScript.
+    #
+    # @return [String] JavaScript source for an onclick attribute.
+    def toggle_yaml_keys_script
+      <<~JAVASCRIPT.gsub(/\s+/, " ").tr('"', "'")
+        var block = this.closest('.ultra-settings-block');
+        if (block) {
+          var hidden = block.classList.toggle('ultra-settings-yaml-hidden');
+          this.setAttribute('aria-checked', hidden ? 'false' : 'true');
+        }
+      JAVASCRIPT
+    end
+
     def open_panel_script
       <<~JAVASCRIPT.gsub(/\s+/, " ").tr('"', "'")
         var el = this;
@@ -146,6 +254,38 @@ module UltraSettings
       JAVASCRIPT
     end
 
+    # Inline script for the copy button. It is inlined on the element so that the
+    # button also works when the configuration view is embedded in a host
+    # application page that does not include the bundled JavaScript.
+    #
+    # @return [String] JavaScript source for an onclick attribute.
+    def copy_value_script
+      <<~JAVASCRIPT.gsub(/\s+/, " ").tr('"', "'")
+        var btn = this;
+        var text = btn.dataset.copyValue || '';
+        var flash = function() {
+          btn.classList.add('copied');
+          window.setTimeout(function() { btn.classList.remove('copied'); }, 1500);
+        };
+        var fallback = function() {
+          var input = document.createElement('textarea');
+          input.value = text;
+          input.setAttribute('readonly', '');
+          input.style.position = 'fixed';
+          input.style.opacity = '0';
+          document.body.appendChild(input);
+          input.select();
+          try { if (document.execCommand('copy')) { flash(); } } catch (e) {}
+          document.body.removeChild(input);
+        };
+        if (navigator.clipboard && navigator.clipboard.writeText) {
+          navigator.clipboard.writeText(text).then(flash, fallback);
+        } else {
+          fallback();
+        }
+      JAVASCRIPT
+    end
+
     def source_priority
       [:env, :settings, :yaml, :default]
     end
@@ -196,6 +336,23 @@ module UltraSettings
       HTML
     end
 
+    def copy_icon(size = 13)
+      <<~HTML
+        <svg class="ultra-settings-copy-icon" width="#{size}" height="#{size}" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+          <rect x="9" y="9" width="13" height="13" rx="2"/>
+          <path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"/>
+        </svg>
+      HTML
+    end
+
+    def check_icon(size = 13)
+      <<~HTML
+        <svg class="ultra-settings-copy-check" width="#{size}" height="#{size}" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round">
+          <polyline points="20 6 9 17 4 12"/>
+        </svg>
+      HTML
+    end
+
     def close_icon(size = 16)
       <<~HTML
         <svg width="#{size}" height="#{size}" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round">

data/lib/ultra_settings/mini_i18n.rb

@@ -76,26 +76,30 @@ module UltraSettings
       end
 
       # Load every JSON file from the locales directory, keyed by filename
-      # stem (e.g. "en").
+      # stem (e.g. "en"). The cache is built into a local hash and then
+      # published with a single assignment so that concurrent readers never
+      # see a partially loaded cache.
       def load_all_locales
-        if development_mode?
-          @mutex.synchronize { @cache = {} }
-        end
+        clear_cache! if development_mode?
 
-        return @cache unless @cache.empty?
+        cached = @cache
+        return cached unless cached.empty?
 
         @mutex.synchronize do
-          return @cache unless @cache.empty?
+          cached = @cache
+          return cached unless cached.empty?
 
+          cache = {}
           Dir.glob(File.join(locales_dir, "*.json")).each do |path|
             code = File.basename(path, ".json").downcase
-            @cache[code] = JSON.parse(File.read(path))
+            cache[code] = JSON.parse(File.read(path, encoding: Encoding::UTF_8))
           rescue JSON::ParserError
             # Skip malformed locale files
           end
-        end
 
-        @cache
+          @cache = cache
+          cache
+        end
       end
 
       def locales_dir
@@ -103,7 +107,7 @@ module UltraSettings
       end
 
       def development_mode?
-        ENV.fetch("RACK_ENV", "development") == "development"
+        UltraSettings.__development_mode__?
       end
     end
   end

data/lib/ultra_settings/rack_app.rb

@@ -26,9 +26,9 @@ module UltraSettings
     private
 
     def webview
-      if ENV.fetch("RAILS_ENV", ENV.fetch("RACK_ENV", "development")) == "development"
-        @webview = nil
-      end
+      # Don't cache the view in development mode so that changes to the app files
+      # are picked up without having to restart the server.
+      @webview = nil if UltraSettings.__development_mode__?
       @webview ||= WebView.new(color_scheme: @color_scheme)
     end
 
@@ -62,7 +62,7 @@ module UltraSettings
         parts = entry.strip.split(";")
         tag = parts[0].to_s.strip.downcase.tr("_", "-")
         q = 1.0
-        parts[1..-1].each do |p|
+        parts[1..].each do |p|
           if p.strip.start_with?("q=")
             q = p.strip.sub("q=", "").to_f
           end

data/lib/ultra_settings/view_helper.rb

@@ -4,6 +4,7 @@ module UltraSettings
   # Base class for rendering views.
   module ViewHelper
     @cache = {}
+    @mutex = Mutex.new
 
     class << self
       # Get an ERB template for rendering.
@@ -11,8 +12,7 @@ module UltraSettings
       # @param path [String] The path to the template file.
       # @return [ERB] The compiled ERB template.
       def erb_template(path)
-        @cache.clear if development_mode?
-        @cache["erb:#{path}"] ||= ERB.new(read_app_file(path))
+        fetch("erb:#{path}") { ERB.new(read_app_file(path)) }
       end
 
       # Read a file from the app directory.
@@ -20,8 +20,7 @@ module UltraSettings
       # @param path [String] The path to the file relative to the app directory.
       # @return [String] The contents of the file.
       def read_app_file(path)
-        @cache.clear if development_mode?
-        @cache["file:#{path}"] ||= File.read(File.join(app_dir, path))
+        fetch("file:#{path}") { File.read(File.join(app_dir, path), encoding: Encoding::UTF_8) }
       end
 
       # Get the app directory path.
@@ -33,8 +32,31 @@ module UltraSettings
 
       private
 
+      # Fetch a value from the cache, generating it with the block if needed.
+      # The value is generated outside of the lock since the block may itself
+      # fetch other cached values. The cache hash is never mutated in place; a
+      # copy is published with a single assignment so concurrent readers always
+      # see a consistent hash. Two threads may generate the same value
+      # concurrently; the first one to publish wins.
+      def fetch(key, &block)
+        return yield if development_mode?
+
+        cached = @cache
+        return cached[key] if cached.include?(key)
+
+        value = yield
+        @mutex.synchronize do
+          if @cache.include?(key)
+            @cache[key]
+          else
+            @cache = @cache.merge(key => value)
+            value
+          end
+        end
+      end
+
       def development_mode?
-        ENV.fetch("RACK_ENV", "development") == "development"
+        UltraSettings.__development_mode__?
       end
     end
   end

data/lib/ultra_settings/web_view.rb

@@ -9,23 +9,38 @@ module UltraSettings
 
     # Initialize a new WebView with the specified color scheme.
     #
-    # @param color_scheme [Symbol] The color scheme to use in the UI. This can be `:light`,
-    #   `:dark`, or `:system`. The default is `:light`.
+    # @param color_scheme [Symbol, nil] The color scheme to use in the UI. This can be `:light`,
+    #   `:dark`, or `:system`. When `nil`, a toggle control is rendered and
+    #   `[data-theme=dark]` is used as the dark mode CSS selector.
     def initialize(color_scheme: :light)
-      @color_scheme = (color_scheme || :light).to_sym
+      @color_scheme = color_scheme&.to_sym
+      @dark_mode_selector = @color_scheme.nil? ? "[data-theme=dark]" : nil
       @layout_template = ViewHelper.erb_template("layout.html.erb")
-      @layout_css = scheme_layout_css(@color_scheme)
+      @layout_css = scheme_layout_css(@color_scheme, @dark_mode_selector)
+      @locale = nil
     end
 
     # Render the complete settings page HTML.
     #
-    # @param request [Rack::Request, nil] The current Rack request for access control.
+    # This instance may be shared between concurrent requests, so per-request
+    # state is set on a copy of the view rather than on the shared instance.
+    #
+    # @param request [Rack::Request, nil] The current Rack request. It is accepted
+    #   for backward compatibility but is not used by the view; access control and
+    #   locale resolution are the caller's responsibility.
     # @param locale [String] The locale code for translations.
     # @return [String] The rendered HTML page.
     def render_settings(request = nil, locale: UltraSettings::MiniI18n::DEFAULT_LOCALE)
-      @request = request
-      @locale = locale
-      refresh_super_settings!
+      renderer = dup
+      renderer.instance_variable_set(:@locale, locale)
+      renderer.render_layout
+    end
+
+    # Render the layout template in the context of this instance.
+    #
+    # @return [String] The rendered HTML page.
+    # @api private
+    def render_layout
       @layout_template.result(binding)
     end
 
@@ -34,7 +49,8 @@ module UltraSettings
     # @return [String] The HTML content for the settings.
     def content
       UltraSettings::ApplicationView.new(
-        color_scheme: @color_scheme,
+        color_scheme: @color_scheme || :light,
+        dark_mode_selector: @dark_mode_selector,
         locale: @locale || UltraSettings::MiniI18n::DEFAULT_LOCALE
       ).render
     end
@@ -56,16 +72,10 @@ module UltraSettings
 
     private
 
-    def scheme_layout_css(color_scheme)
+    def scheme_layout_css(color_scheme, dark_mode_selector)
       vars = ViewHelper.erb_template("layout_vars.css.erb").result(binding)
       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/yaml_config.rb

@@ -52,17 +52,25 @@ module UltraSettings
     private
 
     def load_yaml(path)
-      yaml = File.read(path)
+      yaml = File.read(path, encoding: Encoding::UTF_8)
 
       if yaml.include?("<%")
         yaml = ERB.new(yaml).result
       end
 
-      hash = YAML.load(yaml) # rubocop:disable Security/YAMLLoad
+      hash = parse_yaml(yaml)
       hash = {} unless hash.is_a?(Hash)
       hash
     end
 
+    def parse_yaml(yaml)
+      YAML.load(yaml, aliases: true, permitted_classes: [Symbol, Date, Time]) # rubocop:disable Security/YAMLLoad
+    rescue ArgumentError
+      # Psych 3 does not support the aliases or permitted_classes options; its
+      # YAML.load already allows aliases and arbitrary classes.
+      YAML.load(yaml) # rubocop:disable Security/YAMLLoad
+    end
+
     def environment_config(yaml, environment)
       shared = flatten_hash(yaml.fetch("shared", {}))
       env = flatten_hash(yaml.fetch(environment, {}))

data/lib/ultra_settings.rb

@@ -2,6 +2,7 @@
 
 require "erb"
 require "yaml"
+require "date"
 require "time"
 require "pathname"
 require "singleton"
@@ -32,6 +33,10 @@ module UltraSettings
 
   VALID_NAME_PATTERN = /\A[a-z_][a-zA-Z0-9_]*\z/
 
+  # Thread local key used to make the runtime settings reload in the web views reentrant.
+  RELOAD_GUARD_KEY = :ultra_settings_runtime_settings_reloaded
+  private_constant :RELOAD_GUARD_KEY
+
   @configurations = {}
   @mutex = Mutex.new
   @runtime_settings = nil
@@ -177,6 +182,57 @@ module UltraSettings
       @runtime_settings
     end
 
+    # Reload the runtime settings cache and then yield to the block. The web views call
+    # this when rendering so that a setting changed from the UI is displayed on the next
+    # page load rather than whenever the runtime settings engine gets around to
+    # refreshing itself.
+    #
+    # The runtime settings object is reloaded if it responds to `load_settings`. The
+    # `super_settings` gem does, as does anything that delegates to it.
+    #
+    # Calls are reentrant, so a block that renders several views only reloads once.
+    # Wrap a page that embeds more than one `ConfigurationView` in this method to avoid
+    # reloading the runtime settings once per view.
+    #
+    # Errors are not fatal; the page can still show values from the other sources.
+    #
+    # @example Rendering several configurations with a single reload.
+    #   UltraSettings.with_runtime_settings_reloaded do
+    #     configurations.each { |config| output << UltraSettings::ConfigurationView.new(config).render }
+    #   end
+    #
+    # @return [Object] The result of the block.
+    def with_runtime_settings_reloaded
+      return yield if Thread.current[RELOAD_GUARD_KEY]
+
+      Thread.current[RELOAD_GUARD_KEY] = true
+      begin
+        settings = __runtime_settings__
+        if settings.respond_to?(:load_settings)
+          begin
+            settings.load_settings
+          rescue => e
+            warn("UltraSettings: unable to reload runtime settings: #{e.class}: #{e.message}")
+          end
+        end
+
+        yield
+      ensure
+        Thread.current[RELOAD_GUARD_KEY] = nil
+      end
+    end
+
+    # Returns true if the application is running in development mode. This is used by the
+    # web UI to decide if templates, stylesheets, and translations can be cached in memory
+    # or if they need to be re-read from disk on every request.
+    #
+    # @return [Boolean]
+    # @api private
+    def __development_mode__?
+      env = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || ENV["APP_ENV"] || "development"
+      env == "development"
+    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
@@ -266,7 +322,7 @@ module UltraSettings
       settings = settings.to_a
       config_name, values = settings.first
       config_name = config_name.to_s
-      other_settings = settings[1..-1]
+      other_settings = settings[1..]
 
       unless @configurations.include?(config_name)
         raise ArgumentError.new("Unknown configuration: #{config_name.inspect}")
@@ -299,7 +355,15 @@ module UltraSettings
         __load_config__(name, class_name)
       end
 
-      config_classes = ObjectSpace.each_object(Class).select { |klass| klass < Configuration }
+      config_classes = ObjectSpace.each_object(Class).select do |klass|
+        next false unless klass < Configuration
+        next false if klass.name.nil?
+        begin
+          constantize(klass.name).equal?(klass)
+        rescue NameError
+          false
+        end
+      end
       config_classes.collect(&:instance)
     end
 

data/ultra_settings.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.6"
 
   spec.add_development_dependency "bundler"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultra_settings
 version: !ruby/object:Gem::Version
-  version: 2.9.1
+  version: 2.10.1
 platform: ruby
 authors:
 - Brian Durand
@@ -110,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="