super_settings 1.0.1 → 2.0.0

data/lib/super_settings/application/style_vars.css.erb

@@ -0,0 +1,62 @@
+.super-settings {
+  --primary-color-h: 216;
+  --primary-color-s: 98%;
+  --primary-color-l: 52%;
+  --primary-color-hsl: var(--primary-color-h), var(--primary-color-s), var(--primary-color-l);
+  --primary-color: hsl(var(--primary-color-hsl));
+  --primary-contrast-color: #fff;
+  --primary-hover-color: hsl(var(--primary-color-h), var(--primary-color-s), calc(var(--primary-color-l) - 10%));
+  --primary-border-color: hsl(var(--primary-color-h), var(--primary-color-s), calc(var(--primary-color-l) + 10%));
+}
+
+<% unless color_scheme == :dark %>
+  .super-settings {
+    --edit-bg-color: #f2fdf2;
+    --deleted-row-color: darkred;
+    --deleted-row-bg-color: #ffd1d8;
+    --history-key-color: royalblue;
+    --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;
+    --form-control-placeholder-color: #bbb;
+    --modal-bg-color: #fff;
+    --modal-transparency: 0.4;
+    --modal-control-color: #000;
+    --success-color: green;
+    --danger-color: firebrick;
+    --muted-color: #666;
+    --unselected-color: #666;
+  }
+<% end %>
+
+<% if color_scheme == :system %>
+  @media (prefers-color-scheme: dark) {
+<% end %>
+<% if color_scheme == :system || color_scheme == :dark %>
+  .super-settings {
+    --edit-bg-color: #8dc875;
+    --deleted-row-color: #e0b1b8;
+    --deleted-row-bg-color: #7a3636;
+    --history-key-color: #a7d6f4;
+    --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;
+    --form-control-placeholder-color: #aaa;
+    --modal-bg-color: #333;
+    --modal-transparency: 0.75;
+    --modal-control-color: #fff;
+    --success-color: #00ff00;
+    --danger-color: #ff0000;
+    --muted-color: #999;
+    --unselected-color: #ccc;
+  }
+<% end %>
+<% if color_scheme == :system %>
+  }
+<% end %>

data/lib/super_settings/application/styles.css

@@ -1,3 +1,10 @@
+.super-settings-container {
+  padding-left: 15px;
+  padding-right: 15px;
+  margin-left: auto;
+  margin-right: auto;
+}
+
 #settings-table td p {
   margin-top: 0;
   margin-bottom: 0.5rem;
@@ -11,13 +18,9 @@
   width: 100%;
 }
 
-.super-settings-edit-row {
-  background-color: #f2fdf2 !important;
-}
-
 #settings-table tr[data-deleted] td {
-  background-color: #ffd1d8 !important;
-  color: darkred;
+  background-color: var(--deleted-row-bg-color) !important;
+  color: var(--deleted-row-color);
   text-decoration: line-through;
 }
 
@@ -25,16 +28,49 @@
   display: none;
 }
 
+.super-settings-icon {
+  display: inline-block;
+}
+
+.super-settings-icon svg {
+  width: 100%;
+  height: 100%;
+  vertical-align: inherit;
+}
+
+.super-settings-btn-no-chrome {
+  display: inline-block;
+  vertical-align: middle;
+  background-color: transparent;
+  border: 0;
+  padding: 0;
+  cursor: pointer;
+}
+
+
+
+.super-settings-sort-control {
+  color: var(--unselected-color);
+}
+
+.super-settings-sort-control svg {
+  vertical-align: middle;
+}
+
+.super-settings-edit-row {
+  background-color: var(--edit-bg-color) !important;
+}
+
 .super-settings-key {
   overflow-wrap: break-word;
   max-width: 30rem;
-  min-width: 15rem;
+  min-width: 8rem;
 }
 
 .super-settings-value {
   overflow-wrap: break-word;
   max-width: 30rem;
-  min-width: 15rem;
+  min-width: 8rem;
 }
 
 .super-settings-value-type {
@@ -59,7 +95,34 @@
 
 .super-settings-history-key {
   font-weight: normal;
-  color: royalblue;
+  color: var(--history-key-color);
+}
+
+.super-settings-table {
+  width: 100%;
+  max-width: 100%;
+  margin-bottom: 1rem;
+  border-collapse: collapse;
+}
+
+.super-settings-table thead th {
+  vertical-align: bottom;
+  border-bottom: 2px solid var(--table-border-color);
+  white-space: nowrap;
+}
+
+.super-settings-table td, .super-settings-table th {
+  padding: 0.75rem;
+  vertical-align: top;
+  border-top: 1px solid var(--table-border-color);
+}
+
+.super-settings-table-striped tbody tr:nth-of-type(odd) {
+  background-color: var(--alt-row-color);
+}
+
+.super-settings-align-center {
+  text-align: center;
 }
 
 .super-settings-modal {
@@ -72,12 +135,12 @@
   width: 100%;
   height: 100%;
   overflow: auto;
-  background-color: rgba(0,0,0,0.4);
+  background-color: rgba(0, 0, 0, var(--modal-transparency));
 }
 
 .super-settings-modal-dialog {
   margin: auto;
-  background-color: #fff;
+  background-color: var(--modal-bg-color);
   position: relative;
   outline: 0;
   padding: 2em;
@@ -99,7 +162,7 @@
   right: 0;
   border: 0;
   padding: 1ex;
-  background-color: inherit;
+  color: var(--modal-control-color);
   font-size: 1.5rem;
   font-weight: 500;
 }
@@ -122,6 +185,112 @@
 .super-settings-sticky-top {
   position: sticky;
   top: 0;
-  padding: 1rem 0;
-  background-color: white;
+  padding: 1rem;
+  background-color: var(--table-header-bg-color);
+}
+
+.super-settings-form-control {
+  font-family: inherit;
+  margin: 0;
+  overflow: visible;
+  display: block;
+  width: 100%;
+  padding: .375rem .75rem;
+  font-size: 1rem;
+  line-height: 1.5;
+  color: var(--form-control-color);
+  background-color: var(--form-control-bg-color);
+  background-clip: padding-box;
+  border: 1px solid var(--form-control-border-color);
+  border-radius: .25rem;
+  transition: border-color .15s ease-in-out,box-shadow .15s ease-in-out;
+}
+
+.super-settings-form-control::placeholder {
+  color: var(--form-control-placeholder-color);
+}
+
+select.super-settings-form-control:not([size]):not([multiple]) {
+  height: calc(2.25rem + 2px);
+}
+
+.super-settings-form-check {
+  margin-top: .5rem;
+  display: inline-block;
+}
+
+.super-settings-form-check input[type=checkbox] {
+  vertical-align: middle;
+}
+
+.super-settings-form-inline {
+  display: inline-block;
+}
+
+.super-settings-form-inline .super-settings-form-control {
+  display: inline-block;
+  width: auto;
+  vertical-align: middle;
+}
+
+.super-settings-form-control textarea {
+  font-family: inherit;
+  margin: 0;
+  overflow: auto;
+  resize: vertical;
+}
+
+.super-settings-text-success {
+  color: var(--success-color) !important;
+}
+
+.super-settings-text-danger {
+  color: var(--danger-color) !important;
+}
+
+.super-settings-text-muted {
+  color: var(--muted-color) !important;
+}
+
+.super-settings-btn {
+	display: inline-block;
+  vertical-align: middle;
+  padding: 0.375rem 0.75rem;
+	border-radius: 0.375rem;
+	border: 1px solid #dcdcdc;
+	background-color:#f9f9f9;
+	text-decoration: none;
+  text-align: center;
+	font-family: Arial, sans-serif;
+  font-size: 1rem;
+	font-weight: 400;
+  line-height: 1.5;
+  user-select: none;
+  cursor: pointer;
+  transition: color .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out, box-shadow .15s ease-in-out;
+}
+
+.super-settings-btn:hover:not(:disabled) {
+	background-color:#e9e9e9;
+}
+.super-settings-btn:active {
+	position:relative;
+	top:1px;
+}
+.super-settings-btn:disabled {
+  opacity: 0.8;
+  cursor: not-allowed;
+}
+
+.super-settings-btn-primary {
+  background-color: var(--primary-color);
+  border-color: var(--primary-border-color);
+	color: var(--primary-contrast-color);
+}
+.super-settings-btn-primary:hover:not(:disabled) {
+	background-color: var(--primary-hover-color);
+}
+
+.super-settings-btn-primary:disabled {
+  opacity: 0.5;
 }

data/lib/super_settings/application.rb

@@ -10,31 +10,38 @@ module SuperSettings
     # @param layout [String, Symbol] path to an ERB template to use as the layout around the application UI. You can
     #                                pass the symbol +:default+ to use the default layout that ships with the gem.
     # @param add_to_head [String] HTML code to add to the <head> element on the page.
-    def initialize(layout = nil, add_to_head = nil)
+    # @param api_base_url [String] the base URL for the REST API.
+    # @param color_scheme [Symbol] whether to use dark mode for the application UI. If +nil+, the user's system
+    #                              preference will be used.
+    def initialize(layout: nil, add_to_head: nil, api_base_url: nil, color_scheme: nil)
       if layout
         layout = File.expand_path(File.join("application", "layout.html.erb"), __dir__) if layout == :default
-        @layout = ERB.new(File.read(layout))
+        @layout = ERB.new(File.read(layout)) if layout
         @add_to_head = add_to_head
+      else
+        @layout = nil
+        @add_to_head = nil
       end
+
+      @api_base_url = api_base_url
+      @color_scheme = color_scheme&.to_sym
     end
 
-    # Render the specified ERB file in the lib/application directory distributed with the gem.
+    # Render the web UI application HTML.
     #
     # @return [void]
-    def render(erb_file)
-      template = ERB.new(File.read(File.expand_path(File.join("application", erb_file), __dir__)))
+    def render
+      template = ERB.new(File.read(File.expand_path(File.join("application", "index.html.erb"), __dir__)))
       html = template.result(binding)
-      if @layout
-        render_layout { html }
-      else
-        html
-      end
+      html = render_layout { html } if @layout
+      html = html.html_safe if html.respond_to?(:html_safe)
+      html
     end
 
     private
 
     def render_layout
-      @layout.result(binding)
+      @layout&.result(binding)
     end
   end
 end

data/lib/super_settings/attributes.rb

@@ -4,20 +4,13 @@ module SuperSettings
   # Interface to expose mass setting attributes on an object. Setting attributes with a
   # hash will simply call the attribute writers for each key in the hash.
   module Attributes
-    class UnknownAttributeError < StandardError
-    end
-
     def initialize(attributes = nil)
       self.attributes = attributes if attributes
     end
 
     def attributes=(values)
       values.each do |name, value|
-        if respond_to?("#{name}=", true)
-          send("#{name}=", value)
-        else
-          raise UnknownAttributeError.new("unknown attribute #{name.to_s.inspect} for #{self.class}")
-        end
+        send(:"#{name}=", value) if respond_to?(:"#{name}=", true)
       end
     end
   end

data/lib/super_settings/configuration.rb

@@ -25,6 +25,7 @@ module SuperSettings
       def initialize
         @superclass = nil
         @web_ui_enabled = true
+        @color_scheme = false
         @changed_by_block = nil
       end
 
@@ -63,6 +64,14 @@ module SuperSettings
         !!@web_ui_enabled
       end
 
+      # Set dark mode for the web UI. Possible values are :light, :dark, or :system.
+      # The default value is :light.
+      attr_writer :color_scheme
+
+      def color_scheme
+        (@color_scheme ||= :light).to_sym
+      end
+
       # Enhance the controller. You can define methods or call controller class methods like
       # +before_action+, etc. in the block. These will be applied to the engine controller.
       # This is essentially the same a monkeypatching the controller class.

data/lib/super_settings/context/current.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module SuperSettings
+  module Context
+    class Current
+      def initialize
+        @context = {}
+        @seed = nil
+      end
+
+      def include?(key)
+        @context.include?(key)
+      end
+
+      def [](key)
+        @context[key]
+      end
+
+      def []=(key, value)
+        @context[key] = value
+      end
+
+      def delete(key)
+        @context.delete(key)
+      end
+
+      def rand(max = nil)
+        @seed ||= Random.new_seed
+        Random.new(@seed).rand(max || 1.0)
+      end
+    end
+  end
+end

data/lib/super_settings/context.rb

@@ -2,5 +2,8 @@
 
 module SuperSettings
   module Context
+    autoload :Current, File.join(__dir__, "context/current")
+    autoload :RackMiddleware, File.join(__dir__, "context/rack_middleware")
+    autoload :SidekiqMiddleware, File.join(__dir__, "context/sidekiq_middleware")
   end
 end

data/lib/super_settings/controller_actions.rb

@@ -19,7 +19,7 @@ module SuperSettings
 
     # Render the HTML application for managing settings.
     def root
-      html = SuperSettings::Application.new.render("index.html.erb")
+      html = SuperSettings::Application.new.render
       render html: html.html_safe, layout: true
     end
 
@@ -40,7 +40,7 @@ module SuperSettings
 
     # API endpoint for updating settings. See SuperSettings::RestAPI for details.
     def update
-      changed_by = Configuration.instance.controller.changed_by(self)
+      changed_by = SuperSettings.configuration.controller.changed_by(self)
       result = SuperSettings::RestAPI.update(params[:settings], changed_by)
       if result[:success]
         render json: result

data/lib/super_settings/engine.rb

@@ -17,8 +17,6 @@ module SuperSettings
       end
 
       if defined?(Sidekiq.server?) && Sidekiq.server?
-        require_relative "context/sidekiq_middleware"
-
         Sidekiq.configure_server do |sidekiq_config|
           sidekiq_config.server_middleware do |chain|
             chain.prepend(SuperSettings::Context::SidekiqMiddleware)
@@ -29,7 +27,7 @@ module SuperSettings
 
     config.after_initialize do
       # Call the deferred initialization block.
-      configuration = Configuration.instance
+      configuration = SuperSettings.configuration
       configuration.call
 
       SuperSettings.refresh_interval = configuration.refresh_interval unless configuration.refresh_interval.nil?

data/lib/super_settings/history_item.rb

@@ -27,7 +27,7 @@ module SuperSettings
     def changed_by_display
       return changed_by if changed_by.nil?
 
-      display_proc = Configuration.instance.model.changed_by_display
+      display_proc = SuperSettings.configuration.model.changed_by_display
       if display_proc && !changed_by.nil?
         display_proc.call(changed_by) || changed_by
       else

data/lib/super_settings/http_client.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module SuperSettings
+  # This is a simple HTTP client that is used to communicate with the REST API. It
+  # will keep the connection alive and reuse it on subsequent requests.
+  class HttpClient
+    DEFAULT_HEADERS = {"Accept" => "application/json"}.freeze
+    DEFAULT_TIMEOUT = 5.0
+    KEEP_ALIVE_TIMEOUT = 60
+
+    class Error < StandardError
+    end
+
+    class NotFoundError < Error
+    end
+
+    class InvalidRecordError < Error
+      attr_reader :errors
+
+      def initialize(message, errors:)
+        super(message)
+        @errors = errors
+      end
+    end
+
+    def initialize(base_url, headers: nil, params: nil, timeout: nil, user: nil, password: nil)
+      base_url = "#{base_url}/" unless base_url.end_with?("/")
+      @base_uri = URI(base_url)
+      @base_uri.query = query_string(params) if params
+      @headers = headers ? DEFAULT_HEADERS.merge(headers) : DEFAULT_HEADERS
+      @timeout = timeout || DEFAULT_TIMEOUT
+      @user = user
+      @password = password
+      @mutex = Mutex.new
+      @connections = []
+    end
+
+    def get(path, params = nil)
+      request = Net::HTTP::Get.new(request_uri(path, params))
+      send_request(request)
+    end
+
+    def post(path, params = nil)
+      request = Net::HTTP::Post.new(request_uri(path))
+      request.body = JSON.dump(params) if params
+      send_request(request)
+    end
+
+    private
+
+    def send_request(request)
+      set_headers(request)
+      response_payload = nil
+      attempts = 0
+
+      with_connection do |http|
+        http.start unless http.started?
+        response = http.request(request)
+
+        begin
+          response.value # raises exception unless response is a success
+          response_payload = JSON.parse(response.body)
+        rescue Net::ProtocolError
+          if [404, 410].include?(response.code.to_i)
+            raise NotFoundError.new("#{response.code} #{response.message}")
+          elsif response.code.to_i == 422
+            raise InvalidRecordError.new("#{response.code} #{response.message}", errors: JSON.parse(response.body)["errors"])
+          else
+            raise Error.new("#{response.code} #{response.message}")
+          end
+        rescue JSON::JSONError => e
+          raise Error.new(e.message)
+        end
+      rescue IOError, Errno::ECONNRESET => connection_error
+        attempts += 1
+        retry if attempts <= 1
+        raise connection_error
+      end
+
+      response_payload
+    end
+
+    def with_connection(&block)
+      http = pop_connection
+      begin
+        response = yield(http)
+        return_connection(http)
+        response
+      rescue => e
+        begin
+          http.finish if http.started?
+        rescue IOError
+        end
+        raise e
+      end
+    end
+
+    def pop_connection
+      http = nil
+      @mutex.synchronize do
+        http = @connections.pop
+      end
+      http = nil unless http&.started?
+      http ||= new_connection
+      http
+    end
+
+    def return_connection(http)
+      @mutex.synchronize do
+        if @connections.empty?
+          @connections.push(http)
+          http = nil
+        end
+      end
+
+      if http
+        begin
+          http.finish if http.started?
+        rescue IOError
+        end
+      end
+    end
+
+    def new_connection
+      http = Net::HTTP.new(@base_uri.host, @base_uri.port || @base_uri.inferred_port)
+      http.use_ssl = @base_uri.scheme == "https"
+      http.open_timeout = @timeout
+      http.read_timeout = @timeout
+      http.write_timeout = @timeout
+      http.keep_alive_timeout = KEEP_ALIVE_TIMEOUT
+      http
+    end
+
+    def set_headers(request)
+      @headers.each do |name, value|
+        name = name.to_s
+        values = Array(value)
+        request[name] = values[0].to_s
+        values[1, values.length].each do |val|
+          request.add_field(name, val.to_s)
+        end
+      end
+    end
+
+    def request_uri(path, params = nil)
+      uri = URI.join(@base_uri, path.delete_prefix("/"))
+      if (params && !params.empty?) || (@base_uri.query && !@base_uri.query.empty?)
+        uri.query = [uri.query, query_string(params)].join("&")
+      end
+      uri
+    end
+
+    def query_string(params)
+      q = []
+      q << @base_uri.query unless @base_uri.query.to_s.empty?
+      params&.each do |name, value|
+        q << "#{URI.encode_www_form_component(name.to_s)}=#{URI.encode_www_form_component(value.to_s)}"
+      end
+      q.join("&")
+    end
+  end
+end

data/lib/super_settings/local_cache.rb

@@ -240,21 +240,6 @@ module SuperSettings
       end
     end
 
-    # Recusive method for creating a nested hash from delimited keys.
-    def set_nested_hash_value(hash, key, value, current_depth, delimiter:, max_depth:)
-      key, sub_key = ((max_depth && current_depth < max_depth) ? [key, nil] : key.split(delimiter, 2))
-      if sub_key
-        sub_hash = hash[key]
-        unless sub_hash.is_a?(Hash)
-          sub_hash = {}
-          hash[key] = sub_hash
-        end
-        set_nested_hash_value(sub_hash, sub_key, value, current_depth + 1, delimiter: delimiter, max_depth: max_depth)
-      else
-        hash[key] = value
-      end
-    end
-
     # Recursively freeze a hash.
     def deep_freeze_hash(hash)
       hash.each_value do |value|