ultra_settings 2.10.0 → 2.10.1

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}")

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.10.0
+  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:
   - - ">="