ultra_settings 1.1.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d1abe56c058f7f49b6779f96ff26d30d1ee3e5999bf87c968ad33e8facc6373
-  data.tar.gz: 6874bafd6563bc37df15cfa4fb14119a8ad4ec4b82e70360701939942079c2a3
+  metadata.gz: 35efcdf391347182451bb26d3740e3d18c6e8c5bb4ff4d0100d0f418bb2eef7c
+  data.tar.gz: ed5721d08d451893fbce63317d92d024a7f2cff1e0c68616455b3343b62eb7a6
 SHA512:
-  metadata.gz: 0d06174f43873463ec1fa05d7289d4a32e404a9baaa582eac26c79182bfa530ebe9cf4852cf6835d09e4cf98a6b06a788c659d54b488198b0f2c5072e725b7a8
-  data.tar.gz: 7426f9c5ff9bfd7153a3d4d916bc45f6f10821b891c821371800449eeec29e0bce3b2bf9693f85b8a6c780a2fb6044fd5bfd66f003ffd77ef005c21dada4a3b9
+  metadata.gz: 4636930f294c4c28389da0ed2e627554b1128a92f7fd622a0ac6eb905e6295ae46c513c449a3552e548b840a24d1c05ea106d32a8896a603ce98c596b0d72313
+  data.tar.gz: f8aa279a14715cc6a5a170d43dbaa1e38a55104b92dd25c403fb3b24b4066048bdb69159bf54cf9a3fb44a4280ccd91dba524ddbdca783eabca678ac5f28460e

data/CHANGELOG.md

@@ -4,6 +4,27 @@ 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.1.0
+
+### Added
+
+- Added option to specify the color scheme for the web UI when mounting the rack app to support dark mode.
+
+### Fixed
+
+- Times stored as strings representing the seconds since the epoch are now correctly parsed as Time objects.
+
+## 2.0.0
+
+### Fixed
+
+- **Breaking Change:** Fix conflict with overridding the standard `include?` method on configuration classes. These methods are now defined as `UltraSettings.added?` and `UltraSettings::Configuration.include_field?`.
+- **Breaking Change:** Include namespace in autoloaded configuration names for Rails applications to avoid conflicts on classes in different namespaces.
+
+### Changed
+
+- Use configuration class in in web UI dropdown menu.
+
 ## 1.1.2
 
 ### Added

data/README.md

@@ -346,6 +346,12 @@ mount Rack::Builder.new do
 end, at: "/ultra_settings"
 ```
 
+You can specify the color scheme by setting by providing the `color_scheme` option to the `UltraSettings::RackApp` class. The default color scheme is `:light`. You can also set the scheme to `:dark` or `:system`.
+
+```ruby
+UltraSettings::RackApp.new(color_scheme: :dark)
+```
+
 #### Embedding the Settings View in Admin Tools
 
 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:
@@ -421,6 +427,25 @@ end
 
 This approach keeps your tests clean and readable while allowing for flexible configuration management during testing.
 
+### Rollout percentages
+
+A common usage of configuration is to control rollout of new features by specifying a percentage value and then testing if a random number is less than it. If you implement this pattern in your configuration, then you should use something like the [consistent_random](https://github.com/bdurand/consistent_random) gem to ensure you are generating consistent values without your units of work.
+
+```ruby
+class MyServiceConfiguration < UltraSettings::Configuration
+  field :use_http2_percentage,
+    type: :float,
+    default: 0.0,
+    description: "Rollout percentage for using the new HTTP/2 driver"
+
+  # Using ConsistentRandom#rand instead of Kernel#rand to ensure that we
+  # get the same result within a request and don't oscillate back and forth
+  # every time we check if this is enabled.
+  def use_http2?
+    ConsistentRandom.new("MyServiceConfiguration.use_http2").rand < use_http2_percentage
+  end
+end
+```
 
 ## Installation
 
@@ -446,6 +471,24 @@ Open a pull request on [GitHub](https://github.com/bdurand/ultra_settings).
 
 Please use the [standardrb](https://github.com/testdouble/standard) syntax and lint your code with `standardrb --fix` before submitting.
 
+You can start a local rack server to test the web UI by running
+
+```bash
+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
+```
+
+You can test dark mode by setting the `COLOR_SCHEME` environment variable.
+
+```bash
+COLOR_SCHEME=dark bundle exec rackup
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION

@@ -1 +1 @@
-1.1.2
+2.1.0

data/app/application.css

@@ -15,29 +15,30 @@
 
 .ultra-settings-table thead th {
   vertical-align: bottom;
-  border-bottom: 2px solid #dee2e6;
+  border-bottom: 2px solid var(--table-border-color);
+  background-color: var(--table-header-bg-color);
 }
 
 .ultra-settings-table td, .ultra-settings-table th {
   padding: 0.75rem;
   vertical-align: top;
-  border-top: 1px solid #dee2e6;
+  border-top: 1px solid var(--table-border-color);
 }
 
 .ultra-settings-table tbody tr:nth-of-type(odd) {
-  background-color: rgba(0, 0, 0, .03);
+  background-color: var(--alt-row-color);
 }
 
 .ultra-settings-table code {
   font-family: monospace;
   font-size: 0.9rem;
   display: inline;
-  color: darkred;
+  color: var(--code-color);
   font-weight: 600;
 }
 
 .ultra-settings-table em {
-  color: gray;
+  color: var(--em-color);
   font-style: italic;
   font-size: 0.9rem;
 }
@@ -49,13 +50,13 @@
   font-size: 1rem;
   font-weight: 400;
   line-height: 1.5;
-  color: #212529;
-  background-color: #fff;
+  color: var(--form-control-color);
+  background-color: var(--form-control-bg-color);
   background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'%3e%3cpath fill='none' stroke='%23343a40' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M2 5l6 6 6-6'/%3e%3c/svg%3e");
   background-repeat: no-repeat;
   background-position: right .75rem center;
   background-size: 16px 12px;
-  border: 1px solid #ced4da;
+  border: 1px solid var(--form-control-border-color);
   border-radius: .25rem;
   transition: border-color .15s ease-in-out,box-shadow .15s ease-in-out;
   -webkit-appearance: none;

data/app/application_vars.css.erb

@@ -0,0 +1,31 @@
+<% unless color_scheme == :dark %>
+  .ultra-settings-configuration {
+    --table-header-bg-color: #fff;
+    --table-border-color: #dee2e6;
+    --alt-row-color: rgba(0, 0, 0, .05);
+    --form-control-color: #495057;
+    --form-control-bg-color: #fff;
+    --form-control-border-color: #ced4da;
+    --code-color: darkred;
+    --em-color: gray;
+  }
+<% end %>
+
+<% if color_scheme == :system %>
+  @media (prefers-color-scheme: dark) {
+<% end %>
+<% if color_scheme == :system || color_scheme == :dark %>
+  .ultra-settings-configuration {
+    --table-header-bg-color: #333;
+    --table-border-color: #555;
+    --alt-row-color: rgba(0, 0, 0, .30);
+    --form-control-color: #eee;
+    --form-control-bg-color: #666;
+    --form-control-border-color: #555;
+    --code-color: pink;
+    --em-color: #999;
+  }
+<% end %>
+<% if color_scheme == :system %>
+  }
+<% end %>

data/app/configuration.html.erb

@@ -20,7 +20,7 @@
         <th>Notes</th>
       </tr>
     </thead>
-    <tbody>
+    <tbody translate="no">
       <% configuration.class.fields.each do |field| %>
         <% source = configuration.__source__(field.name) %>
         <tr>

data/app/index.html.erb

@@ -1,8 +1,8 @@
 <div class="ultra-settings-nav">
-  <form onsubmit="return false">
+  <form onsubmit="return false" style="margin-bottom: 0.5rem;">
     <select class="<%= html_escape(select_class) %>" size="1" id="config-selector">
       <% UltraSettings.__configuration_names__.sort.each do |name| %>
-        <option value="config-<%= html_escape(name) %>"><%= html_escape(name) %></option>
+        <option value="config-<%= html_escape(name) %>"><%= html_escape(UltraSettings.send(name).class.name) %></option>
       <% end %>
     </select>
   </form>

data/app/layout.css

@@ -1,12 +1,14 @@
-* {box-sizing:border-box;}
+* {
+  box-sizing:border-box;
+}
 
 body {
   font-family: sans-serif;
   font-size: 1rem;
   line-height: 1.5;
   text-align: left;
-  color: #212529;
-  background-color: #ffffff;
+  color: var(--text-color);
+  background-color: var(--background-color);
   margin: 0;
   padding: 0;
 }

data/app/layout.html.erb

@@ -5,6 +5,7 @@
     <title>Application Configuration</title>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="format-detection" content="telephone=no email=no date=no address=no">
     <style type="text/css">
       <%= @layout_css %>
       <%= css %>

data/app/layout_vars.css.erb

@@ -0,0 +1,19 @@
+<% unless color_scheme != :dark %>
+  :root {
+    --text-color: #212529;
+    --background-color: #ffffff;
+  }
+<% end %>
+
+<% if color_scheme == :system %>
+  @media (prefers-color-scheme: dark) {
+<% end %>
+<% if color_scheme == :system || color_scheme == :dark %>
+  :root {
+    --text-color: #fff;
+    --background-color: #333;
+  }
+<% end %>
+<% if color_scheme == :system %>
+  }
+<% end %>

data/lib/ultra_settings/coerce.rb

@@ -18,6 +18,8 @@ module UltraSettings
     ]).freeze
     # rubocop:enable Lint/BooleanSymbol
 
+    NUMERIC_REGEX = /\A-?\d+(?:\.\d+)?\z/
+
     class << self
       # Cast a value to a specific type.
       #
@@ -33,13 +35,19 @@ module UltraSettings
         when :float
           value.is_a?(Float) ? value : value.to_s&.to_f
         when :boolean
-          Coerce.boolean(value)
+          boolean(value)
         when :datetime
-          Coerce.time(value)
+          time(value)
         when :array
           Array(value).map(&:to_s)
         when :symbol
           value.to_s.to_sym
+        when :rollout
+          if numeric?(value)
+            value.to_f
+          else
+            boolean(value)
+          end
         else
           value.to_s
         end
@@ -50,13 +58,9 @@ module UltraSettings
       # @param value [Object]
       # @return [Boolean]
       def boolean(value)
-        if value == false
-          false
-        elsif blank?(value)
-          nil
-        else
-          !FALSE_VALUES.include?(value)
-        end
+        return nil if blank?(value)
+
+        !FALSE_VALUES.include?(value)
       end
 
       # Cast a value to a Time object.
@@ -66,8 +70,9 @@ module UltraSettings
       def time(value)
         value = nil if value.nil? || value.to_s.empty?
         return nil if value.nil?
-        time = if value.is_a?(Numeric)
-          Time.at(value)
+
+        time = if numeric?(value)
+          Time.at(value.to_f)
         elsif value.respond_to?(:to_time)
           value.to_time
         else
@@ -79,9 +84,15 @@ module UltraSettings
         time
       end
 
+      # @return [Boolean] true if the value is a numeric type or a string representing a number.
+      def numeric?(value)
+        value.is_a?(Numeric) || (value.is_a?(String) && value.to_s.match?(NUMERIC_REGEX))
+      end
+
       # @return [Boolean] true if the value is nil or empty.
       def blank?(value)
         return true if value.nil?
+
         if value.respond_to?(:empty?)
           value.empty?
         else

data/lib/ultra_settings/configuration.rb

@@ -64,7 +64,7 @@ module UltraSettings
           secret: secret
         )
 
-        class_eval <<-RUBY, __FILE__, __LINE__ + 1 # rubocop:disable Security/Eval
+        class_eval <<~RUBY, __FILE__, __LINE__ + 1 # rubocop:disable Security/Eval
           def #{name}
             __get_value__(#{name.inspect})
           end
@@ -86,12 +86,12 @@ module UltraSettings
       #
       # @param name [Symbol, String] The name of the field.
       # @return [Boolean]
-      def include?(name)
+      def include_field?(name)
         name = name.to_s
         return true if defined_fields.include?(name)
 
         if superclass <= Configuration
-          superclass.include?(name)
+          superclass.include_field?(name)
         else
           false
         end
@@ -446,7 +446,7 @@ module UltraSettings
     end
 
     def include?(name)
-      self.class.include?(name.to_s)
+      self.class.include_field?(name.to_s)
     end
 
     def override!(values, &block)

data/lib/ultra_settings/rack_app.rb

@@ -5,8 +5,9 @@ module UltraSettings
   # No setting values are displayed, but you should still add some
   # sort of authentication if you want to use this in production.
   class RackApp
-    def initialize
+    def initialize(color_scheme: nil)
       @webview = nil
+      @color_scheme = color_scheme
     end
 
     def call(env)
@@ -19,7 +20,7 @@ module UltraSettings
       if ENV.fetch("RAILS_ENV", ENV.fetch("RACK_ENV", "development")) == "development"
         @webview = nil
       end
-      @webview ||= WebView.new
+      @webview ||= WebView.new(color_scheme: @color_scheme)
     end
   end
 end

data/lib/ultra_settings/railtie.rb

@@ -23,9 +23,12 @@ module UltraSettings
 
         app_config_dir = Rails.root.join(directory)
         app_config_dir.glob("**/*_configuration.rb").each do |file_path|
-          config_name = file_path.basename("_configuration.rb")
-          class_name = file_path.relative_path_from(app_config_dir).to_s.chomp(".rb").classify
-          UltraSettings.add(config_name, class_name)
+          relative_path = file_path.relative_path_from(app_config_dir).to_s
+          class_name = relative_path.chomp(".rb").classify
+          unless UltraSettings.added?(class_name)
+            config_name = class_name.delete_suffix("Configuration").underscore.tr("/", "_")
+            UltraSettings.add(config_name, class_name)
+          end
         end
       end
     end

data/lib/ultra_settings/web_view.rb

@@ -5,10 +5,13 @@ module UltraSettings
   class WebView
     attr_reader :css
 
-    def initialize
+    # @param color_scheme [Symbol] The color scheme to use in the UI. This can be `:light`,
+    #  `:dark`, or `:system`. The default is `:light`.
+    def initialize(color_scheme: :light)
+      color_scheme = (color_scheme || :light).to_sym
       @layout_template = erb_template("layout.html.erb")
-      @layout_css = read_app_file("layout.css")
-      @css = read_app_file("application.css")
+      @layout_css = layout_css(color_scheme)
+      @css = application_css(color_scheme)
     end
 
     def render_settings
@@ -32,5 +35,17 @@ module UltraSettings
     def app_dir
       File.expand_path(File.join("..", "..", "app"), __dir__)
     end
+
+    def layout_css(color_scheme)
+      vars = erb_template("layout_vars.css.erb").result(binding)
+      css = read_app_file("layout.css")
+      "#{vars}\n#{css}"
+    end
+
+    def application_css(color_scheme)
+      vars = erb_template("application_vars.css.erb").result(binding)
+      css = read_app_file("application.css")
+      "#{vars}\n#{css}"
+    end
   end
 end

data/lib/ultra_settings.rb

@@ -46,7 +46,7 @@ module UltraSettings
     def add(name, klass = nil)
       name = name.to_s
       unless name.match?(VALID_NAME__PATTERN)
-        raise ArgementError.new("Invalid configuration name: #{name.inspect}")
+        raise ArgumentError.new("Invalid configuration name: #{name.inspect}")
       end
 
       class_name = klass&.to_s
@@ -67,7 +67,7 @@ module UltraSettings
     #
     # @param class_name [Class, String] The name of the configuration class.
     # @return [Boolean]
-    def include?(class_name)
+    def added?(class_name)
       @configurations.values.collect(&:to_s).include?(class_name.to_s)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultra_settings
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -37,10 +37,12 @@ files:
 - VERSION
 - app/application.css
 - app/application.js
+- app/application_vars.css.erb
 - app/configuration.html.erb
 - app/index.html.erb
 - app/layout.css
 - app/layout.html.erb
+- app/layout_vars.css.erb
 - lib/ultra_settings.rb
 - lib/ultra_settings/application_view.rb
 - lib/ultra_settings/coerce.rb