super_settings 2.3.1 → 2.4.1

data/lib/super_settings/application/styles.css

@@ -5,29 +5,209 @@
   margin-right: auto;
 }
 
-#settings-table td p {
-  margin-top: 0;
-  margin-bottom: 0.5rem;
+/* Card Layout Styles */
+.super-settings-cards-container {
+  display: flex;
+  flex-direction: column;
+  gap: 0.75rem;
+  padding: 1rem 0;
+}
+
+.super-settings-card {
+  border: 2px solid var(--table-border-color);
+  border-radius: 0.5rem;
+  background-color: var(--card-bg-color);
+  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
+  transition: box-shadow 0.2s ease-in-out;
+  width: 100%;
 }
 
-#settings-table td p:last-of-type {
-  margin-bottom: 0;
+.super-settings-card:hover {
+  box-shadow: 0 2px 8px rgba(0, 0, 0, 0.15);
 }
 
-#settings-table input[type=text], #settings-table input[type=number], #settings-table input[type=date], #settings-table input[type=time], #settings-table textarea {
-  width: 100%;
+.super-settings-cards-container .super-settings-card:nth-child(even) {
+  background-color: var(--alt-row-color);
+}
+
+.super-settings-card-edit {
+  background-color: var(--edit-bg-color) !important;
+  border-color: var(--primary-border-color);
 }
 
-#settings-table tr[data-deleted] td {
+.super-settings-card[data-deleted] {
   background-color: var(--deleted-row-bg-color) !important;
   color: var(--deleted-row-color);
+}
+
+.super-settings-card[data-deleted] .js-value-placeholder,
+.super-settings-card[data-deleted] strong,
+.super-settings-card[data-deleted] .super-settings-form-control {
   text-decoration: line-through;
 }
 
-#settings-table tr[data-newrecord] .js-show-history {
-  display: none;
+.super-settings-card[data-deleted] .super-settings-card-label {
+  text-decoration: none;
+}
+
+/* Card content layout for desktop - column alignment */
+@media (min-width: 768px) {
+  .super-settings-card-content {
+    display: grid;
+    grid-template-columns: 2fr 2fr 1fr 3fr 1fr 1fr;
+    gap: 1rem;
+    align-items: start;
+    padding: 1rem;
+  }
+
+  .super-settings-card-key {
+    grid-column: 1;
+  }
+
+  .super-settings-card-value {
+    grid-column: 2;
+    margin-bottom: 0;
+  }
+
+  .super-settings-card-type {
+    grid-column: 3;
+  }
+
+  .super-settings-card-description {
+    grid-column: 4;
+    margin-bottom: 0;
+  }
+
+  .super-settings-card-modified {
+    grid-column: 5;
+  }
+
+  .super-settings-card-controls {
+    grid-column: 6;
+    margin-left: 0;
+  }
+}
+
+/* Mobile layout - stacked */
+@media (max-width: 767px) {
+  .super-settings-card-content {
+    padding: 1rem;
+  }
+
+  .super-settings-card-key {
+    margin-bottom: 1rem;
+  }
+
+  .super-settings-card-value {
+    margin-bottom: 1rem;
+  }
+
+  .super-settings-card-meta {
+    display: grid;
+    grid-template-columns: 1fr 1fr;
+    gap: 1rem;
+    margin-bottom: 1rem;
+  }
+
+  .super-settings-card-description {
+    margin-bottom: 1rem;
+  }
+
+  .super-settings-card-controls {
+    display: flex;
+    gap: 0.25rem;
+    justify-content: flex-end;
+  }
 }
 
+.super-settings-card-key input[type="text"] {
+  margin: 0;
+  width: 100%;
+}
+
+.super-settings-card-controls {
+  display: flex;
+  gap: 0.25rem;
+  flex-shrink: 0;
+}
+
+.super-settings-card-label {
+  display: block;
+  font-size: 0.75rem;
+  font-weight: 600;
+  color: var(--muted-color);
+  margin-bottom: 0.25rem;
+  text-transform: uppercase;
+  letter-spacing: 0.025em;
+}
+
+/* Sort Controls */
+@media (min-width: 768px) {
+  .super-settings-sort-controls {
+    display: grid;
+    grid-template-columns: 2fr 2fr 1fr 3fr 1fr 1fr;
+    gap: 1rem;
+    align-items: center;
+    padding: 0.125rem 1rem 0.125rem 1rem;
+    background-color: transparent;
+    border: none;
+    margin-bottom: 0.25rem;
+  }
+
+  .super-settings-sort-label {
+    display: none;
+  }
+
+  .super-settings-sort-controls .super-settings-sort-control {
+    padding: 0.125rem 0;
+    margin: 0;
+    margin-top: 1rem; /* Align with card content that has labels */
+    text-align: left;
+    font-weight: 600;
+    color: var(--form-control-color);
+  }
+
+  .super-settings-sort-controls > span {
+    font-weight: 600;
+    color: var(--form-control-color);
+  }
+}
+
+/* Mobile sort controls */
+@media (max-width: 767px) {
+  .super-settings-sort-controls {
+    display: flex;
+    align-items: center;
+    gap: 1rem;
+    margin-bottom: 0.5rem;
+    padding: 0.25rem 1rem;
+    background-color: transparent;
+    border: none;
+  }
+
+  .super-settings-sort-label {
+    font-weight: 600;
+    color: var(--form-control-color);
+  }
+
+  .super-settings-sort-control {
+    display: flex;
+    align-items: center;
+    gap: 0.25rem;
+    padding: 0.25rem 0.5rem;
+    border: 1px solid transparent;
+    border-radius: 0.25rem;
+    transition: all 0.2s ease-in-out;
+  }
+
+  .super-settings-sort-control[data-selected="true"] {
+    background-color: var(--primary-color);
+    color: var(--primary-contrast-color);
+    border-color: var(--primary-border-color);
+  }
+}
+
+/* Icons and Button Controls */
 .super-settings-icon {
   display: inline-block;
 }
@@ -47,8 +227,6 @@
   cursor: pointer;
 }
 
-
-
 .super-settings-sort-control {
   color: var(--unselected-color);
 }
@@ -57,74 +235,94 @@
   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: 8rem;
-}
-
-.super-settings-value {
-  overflow-wrap: break-word;
-  max-width: 30rem;
-  min-width: 8rem;
-}
-
-.super-settings-value-type {
-  width: 7rem;
-}
-
-.super-settings-description {
-  min-width: 20rem;
-}
-
+/* Utility Classes */
 .super-settings-max-height-text {
   max-height: 15rem;
   overflow-y: scroll;
 }
 
-.super-settings-controls {
-  width: 6rem;
-  white-space: nowrap;
-  text-align: right;
-  text-decoration: none !important;
-}
-
 .super-settings-history-key {
   font-weight: normal;
   color: var(--history-key-color);
 }
 
-.super-settings-table {
+/* History Display Layout */
+.super-settings-history-container {
   width: 100%;
-  max-width: 100%;
   margin-bottom: 1rem;
-  border-collapse: collapse;
 }
 
-.super-settings-table thead th {
-  vertical-align: bottom;
+.super-settings-history-header {
+  display: grid;
+  grid-template-columns: 2fr 2fr 3fr;
+  gap: 1rem;
+  padding: 0.75rem;
+  font-weight: 600;
   border-bottom: 2px solid var(--table-border-color);
-  white-space: nowrap;
+  background-color: var(--table-header-bg-color);
+}
+
+.super-settings-history-items {
+  display: flex;
+  flex-direction: column;
 }
 
-.super-settings-table td, .super-settings-table th {
+.super-settings-history-item {
+  display: grid;
+  grid-template-columns: 2fr 2fr 3fr;
+  gap: 1rem;
   padding: 0.75rem;
-  vertical-align: top;
-  border-top: 1px solid var(--table-border-color);
+  border-bottom: 1px solid var(--table-border-color);
+  align-items: start;
 }
 
-.super-settings-table-striped tbody tr:nth-of-type(odd) {
+.super-settings-history-item:nth-of-type(even) {
   background-color: var(--alt-row-color);
 }
 
+.super-settings-history-time {
+  white-space: nowrap;
+}
+
+.super-settings-history-user {
+  word-break: break-word;
+}
+
+.super-settings-history-value {
+  word-break: break-word;
+}
+
+/* Mobile responsive layout for history */
+@media (max-width: 767px) {
+  .super-settings-history-header {
+    display: none;
+  }
+
+  .super-settings-history-item {
+    display: block;
+    padding: 1rem;
+    margin-bottom: 0.5rem;
+    border: 1px solid var(--table-border-color);
+    border-radius: 0.5rem;
+    background-color: var(--form-control-bg-color);
+  }
+
+  .super-settings-history-item:nth-of-type(odd) {
+    background-color: var(--form-control-bg-color);
+  }
+
+  .super-settings-history-time,
+  .super-settings-history-user,
+  .super-settings-history-value {
+    margin-bottom: 0.5rem;
+  }
+}
+
 .super-settings-align-center {
   text-align: center;
 }
 
+/* Modal Dialog */
 .super-settings-modal {
   z-index: 1000000000000;
   display: none;
@@ -167,6 +365,7 @@
   font-weight: 500;
 }
 
+/* Screen Reader and Accessibility */
 .super-settings-sr-only {
   position: absolute;
   width: 1px;
@@ -178,6 +377,7 @@
   border: 0;
 }
 
+/* Utility Classes */
 .super-settings-text-nowrap {
   white-space: nowrap !important;
 }
@@ -189,6 +389,24 @@
   background-color: var(--table-header-bg-color);
 }
 
+.super-settings-align-center {
+  text-align: center;
+}
+
+.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;
+}
+
+/* Form Controls */
+
 .super-settings-form-control {
   font-family: inherit;
   margin: 0;
@@ -240,43 +458,43 @@ select.super-settings-form-control:not([size]):not([multiple]) {
   resize: vertical;
 }
 
-.super-settings-text-success {
-  color: var(--success-color) !important;
-}
-
-.super-settings-text-danger {
-  color: var(--danger-color) !important;
+/* Ensure textareas use full width in edit mode */
+.super-settings-card-edit .super-settings-card-description textarea {
+  width: 100%;
+  box-sizing: border-box;
+  min-width: 0; /* Allow shrinking in grid */
 }
 
-.super-settings-text-muted {
-  color: var(--muted-color) !important;
-}
+/* Buttons */
 
 .super-settings-btn {
-	display: inline-block;
+  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;
+  border-radius: 0.375rem;
+  color: var(--form-control-color);
+  border: 1px solid var(--form-control-border-color);
+  background-color: var(--form-control-bg-color);
+  text-decoration: none;
   text-align: center;
-	font-family: Arial, sans-serif;
+  font-family: Arial, sans-serif;
   font-size: 1rem;
-	font-weight: 400;
+  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;
+  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;
+  background-color: var(--btn-hover-color);
 }
+
 .super-settings-btn:active {
-	position:relative;
-	top:1px;
+  position: relative;
+  top: 1px;
 }
+
 .super-settings-btn:disabled {
   opacity: 0.8;
   cursor: not-allowed;
@@ -285,10 +503,11 @@ select.super-settings-form-control:not([size]):not([multiple]) {
 .super-settings-btn-primary {
   background-color: var(--primary-color);
   border-color: var(--primary-border-color);
-	color: var(--primary-contrast-color);
+  color: var(--primary-contrast-color);
 }
+
 .super-settings-btn-primary:hover:not(:disabled) {
-	background-color: var(--primary-hover-color);
+  background-color: var(--primary-hover-color);
 }
 
 .super-settings-btn-primary:disabled {

data/lib/super_settings/application.rb

@@ -29,7 +29,7 @@ module SuperSettings
 
     # Render the web UI application HTML.
     #
-    # @return [void]
+    # @return [String] the rendered HTML
     def render
       template = ERB.new(File.read(File.expand_path(File.join("application", "index.html.erb"), __dir__)))
       html = template.result(binding)

data/lib/super_settings/coerce.rb

@@ -5,6 +5,7 @@ require "set"
 module SuperSettings
   # Utility functions for coercing values to other data types.
   class Coerce
+    # Set of values that should be considered false when converting to boolean.
     # rubocop:disable Lint/BooleanSymbol
     FALSE_VALUES = Set.new([
       "0", :"0",

data/lib/super_settings/context/current.rb

@@ -2,28 +2,51 @@
 
 module SuperSettings
   module Context
+    # Current context for maintaining consistent setting values and random numbers
+    # within a specific execution context.
     class Current
       def initialize
         @context = {}
         @seed = nil
       end
 
+      # Check if the context includes a specific key.
+      #
+      # @param key [String] the key to check
+      # @return [Boolean] true if the key exists in the context
       def include?(key)
         @context.include?(key)
       end
 
+      # Get a value from the context.
+      #
+      # @param key [String] the key to retrieve
+      # @return [Object] the value associated with the key
       def [](key)
         @context[key]
       end
 
+      # Set a value in the context.
+      #
+      # @param key [String] the key to set
+      # @param value [Object] the value to store
+      # @return [Object] the stored value
       def []=(key, value)
         @context[key] = value
       end
 
+      # Delete a value from the context.
+      #
+      # @param key [String] the key to delete
+      # @return [Object] the deleted value
       def delete(key)
         @context.delete(key)
       end
 
+      # Generate a consistent random number for this context.
+      #
+      # @param max [Integer, Float, Range] the maximum value or range
+      # @return [Integer, Float] the random number
       def rand(max = nil)
         @seed ||= Random.new_seed
         Random.new(@seed).rand(max || 1.0)

data/lib/super_settings/context.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module SuperSettings
+  # Context classes for maintaining consistent state during execution blocks.
+  # These contexts ensure that settings and random values remain constant
+  # within a specific execution scope.
   module Context
     autoload :Current, File.join(__dir__, "context/current")
     autoload :RackMiddleware, File.join(__dir__, "context/rack_middleware")

data/lib/super_settings/local_cache.rb

@@ -60,6 +60,7 @@ module SuperSettings
       end
 
       return nil if value == NOT_DEFINED
+
       value
     end
 
@@ -105,11 +106,15 @@ module SuperSettings
     end
 
     # Load all the settings from the database into the cache.
+    #
+    # @param asynchronous [Boolean] whether to load settings in a background thread
+    # @return [void]
     def load_settings(asynchronous = false)
       return if @refreshing
 
       @lock.synchronize do
         return if @refreshing
+
         @refreshing = true
         @next_check_at = Time.now + @refresh_interval
       end
@@ -135,6 +140,9 @@ module SuperSettings
     end
 
     # Load only settings that have changed since the last load.
+    #
+    # @param asynchronous [Boolean] whether to refresh settings in a background thread
+    # @return [void]
     def refresh(asynchronous = false)
       last_refresh_time = @last_refreshed
       return if last_refresh_time.nil?
@@ -142,8 +150,10 @@ module SuperSettings
 
       @lock.synchronize do
         return if @refreshing
+
         @next_check_at = Time.now + @refresh_interval
         return if @cache.empty?
+
         @refreshing = true
       end
 
@@ -166,6 +176,8 @@ module SuperSettings
     end
 
     # Reset the cache to an unloaded state.
+    #
+    # @return [void]
     def reset
       @lock.synchronize do
         @cache = {}.freeze
@@ -189,6 +201,7 @@ module SuperSettings
     # @api private
     def update_setting(setting)
       return if Coerce.blank?(setting.key)
+
       @lock.synchronize do
         @cache = @cache.merge(setting.key => setting.value)
       end
@@ -199,6 +212,7 @@ module SuperSettings
     def wait_for_load
       loop do
         return unless @refreshing
+
         sleep(0.001)
       end
     end

data/lib/super_settings/rack_application.rb

@@ -11,7 +11,7 @@ module SuperSettings
   #
   # You are also responsible for implementing any CSRF protection if your authentication method
   # uses stateful requests (i.e. cookies or Basic auth where browser automatically include the
-  # credentials on every reqeust). There are other gems available that can be integrated into
+  # credentials on every request). There are other gems available that can be integrated into
   # your middleware stack to provide this feature. If you need to inject meta elements into
   # the page, you can do so with the +add_to_head+ method.
   class RackApplication
@@ -225,8 +225,10 @@ module SuperSettings
     def check_authorization(request, write_required: false)
       user = current_user(request)
       return json_response(401, error: "Authentiation required") unless authenticated?(user)
+
       allowed = (write_required ? allow_write?(user) : allow_read?(user))
       return json_response(403, error: "Access denied") unless allowed
+
       yield(user)
     end