super_settings 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83d20aa4f55a73597f12a1fed76db8d01bd81ec128b5208ed60ff8acc82a273b
-  data.tar.gz: c2bf00fe10c179d9ddc6849fbc6b2be2eb511b8132463a143e202ea42996581b
+  metadata.gz: f22da070d026588b18f51a2fa161ef32fc08d0179a7b10f3251d55f954da9fc4
+  data.tar.gz: 31fe028eafb566c3e05fe99e08f4b7c8113d5812ac82871e315c71724bae0c7a
 SHA512:
-  metadata.gz: 6fec2ccebbc1f84a7bb1878c4b6ea5f9fb5b36eacb0fddc3fcc2520ce3e738d895bf540be762a225aab970cc102287f5598b99588f4ad82494b726306b3f4601
-  data.tar.gz: 4d9d0641b7b47a845c26f6e72fccdd996c81b5e5f25c88d93b9148ca1c1767fe4c4d97681b558af0490028cbac3ac9e1ac447271b971829f2e8f3ea2a11311fd
+  metadata.gz: 1df8b3b2c0b6d99f7f3902c5e8fbc056f83446cfed7c990e9208b6aa18131503ad02f78b8d109b0e2f84e62f1466f77138b27b2391190622dab9a4fb9d948a1e
+  data.tar.gz: 2c3d3f56c9d7a67a745c012bc1f77c55d3e74012e79a018b9d191bf32d3125062992f4d3fc255b432e11ada92605bcf0ac8df3e8e928f239c432f079546892c4

data/CHANGELOG.md

@@ -4,6 +4,18 @@ 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.0.2
+
+### Fixed
+
+- Coercing a string to a boolean is now case insensitive (i.e. "True" is interpreted as `true` and "False" is interpreted as `false`).
+
+## 2.0.1
+
+### Added
+
+- Added support for targeting a editing a specific setting in the web UI by passing `#edit=key` in the URL hash.
+
 ## 2.0.0
 
 ### Added

data/README.md

@@ -24,19 +24,25 @@ Key features include:
 
 For projects that require a combination of runtime settings, environment variables, and YAML files, SuperSettings integrates seamlessly with [ultra_settings](https://github.com/bdurand/ultra_settings), creating a flexible and powerful configuration system.
 
-## Usage
+## Table Of Contents
+
+- [Usage](#usage)
+  - [Getting Value](#getting-values)
+    - [Hashes](#hashes)
+    - [Defaults](#defaults)
+    - [Caching](#caching)
+  - [Data Model](#data-model)
+    - [Storage Engines](#storage-engines)
+  - [Web UI](#web-ui)
+    - [REST API](#rest-api)
+    - [Authentication](#authentication)
+  - [Rails Engine](#rails-engine)
+    - [Configuration](#configuration)
+- [Installation](#installation)
+- [Contributing](#contributing)
+- [License](#license)
 
-- [Getting Value](#getting-values)
-  - [Hashes](#hashes)
-  - [Defaults](#defaults)
-  - [Caching](#caching)
-- [Data Model](#data-model)
-  - [Storage Engines](#storage-engines)
-- [Web UI](#web-ui)
-  - [REST API](#rest-api)
-  - [Authentication](#authentication)
-- [Rails Engine](#rails-engine)
-  - [Configuration](#configuration)
+## Usage
 
 ### Getting Values
 
@@ -175,6 +181,8 @@ You can change the layout used by the Web UI. However, if you do this, you will
 
 It is not required to use the bundled Web UI. You can implement your own UI using the `SuperSettings::Setting` model.
 
+You can link directly to editing a setting by passing `#edit=key` in the URL hash. This will open the Web UI with the setting with the key `key` selected for editing.
+
 #### REST API
 
 You can mount a REST API for exposing and managing the settings. This API is required for the Web UI and is mounted along with the Web UI. The REST interface is documented in the `SuperSettings::RestAPI` class.

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.0.2

data/lib/super_settings/application/scripts.js

@@ -232,9 +232,12 @@
   }
 
   // Create a table row with form elements for creating a new setting.
-  function newSettingRow() {
+  function newSettingRow(key) {
+    if (!key) {
+      key = "";
+    }
     const randomId = "new" + Math.floor((Math.random() * 0xFFFFFFFFFFFFFF)).toString(16);
-    const setting = {id: randomId, key: "", value: "", value_type: "string", new_record: true}
+    const setting = {id: randomId, key: key, value: "", value_type: "string", new_record: true}
     row = editSettingRow(setting);
     return row;
   }
@@ -456,6 +459,33 @@
     return found;
   }
 
+  // Find a setting by key.
+  function findSettingByKey(key) {
+    let found = null;
+    activeSettings.forEach(function(setting) {
+      if (setting.key === key) {
+        found = setting;
+        return;
+      }
+    });
+    return found;
+  }
+
+  // Add a new setting.
+  function addSetting(key) {
+    const row = addRowToTable(newSettingRow(key));
+    row.querySelector(".super-settings-key input").focus();
+  }
+
+  function editSetting(setting) {
+    const row = addRowToTable(editSettingRow(setting));
+    if (row.querySelector(".super-settings-value .js-date-input")) {
+      row.querySelector(".super-settings-value .js-date-input").focus();
+    } else {
+      row.querySelector(".super-settings-value .js-setting-value").focus();
+    }
+  }
+
   /*** Event Listeners ***/
 
   // Listener for showing the setting history modal.
@@ -542,23 +572,17 @@
   }
 
   // Listener for the add setting button.
-  function addSetting(event) {
+  function addSettingListener(event) {
     event.preventDefault();
-    const row = addRowToTable(newSettingRow());
-    row.querySelector(".super-settings-key input").focus();
+    addSetting();
   }
 
   // Listener for the edit setting button.
-  function editSetting(event) {
+  function editSettingListener(event) {
     event.preventDefault();
     const id = event.target.closest("tr").dataset.id;
-    const setting = findSetting(id);
-    const row = addRowToTable(editSettingRow(setting));
-    if (row.querySelector(".super-settings-value .js-date-input")) {
-      row.querySelector(".super-settings-value .js-date-input").focus();
-    } else {
-      row.querySelector(".super-settings-value .js-setting-value").focus();
-    }
+    setting = findSetting(id);
+    editSetting(setting);
   }
 
   // Listener for the restore setting button.
@@ -656,6 +680,18 @@
     window.location = url;
   }
 
+  // Open the setting if the URL hash includes #edit=setting.
+  function fetchEditHash() {
+    const hash = window.location.hash;
+    if (hash.startsWith("#edit=")) {
+      const name = hash.replace("#edit=", "");
+      window.location.hash = "";
+      return name;
+    } else {
+      return null;
+    }
+  }
+
   // Support integration into single page applications where OAuth2 access tokens are used.
   // The access token can be passed either in the access_token query parameter per the
   // OAuth2 standard, or in the URL hash. Passing it in the hash will prevent it from ever
@@ -694,7 +730,7 @@
   // Bind event listeners for setting controls on a setting table row.
   function bindSettingControlEvents(parent) {
     addListener(parent.querySelectorAll(".js-remove-setting"), "click", removeSetting);
-    addListener(parent.querySelectorAll(".js-edit-setting"), "click", editSetting);
+    addListener(parent.querySelectorAll(".js-edit-setting"), "click", editSettingListener);
     addListener(parent.querySelectorAll(".js-restore-setting"), "click", restoreSetting);
     addListener(parent.querySelectorAll(".js-show-history"), "click", showHistoryModal);
     addListener(parent.querySelectorAll(".js-no-op"), "click", noOp);
@@ -802,11 +838,19 @@
     }
   }
 
-  function fetchActiveSettings() {
+  function fetchActiveSettings(editKey) {
     SuperSettingsAPI.fetchSettings(function(settings_hash) {
       const settings = settings_hash["settings"];
       activeSettings = settings;
       renderSettingsTable(settings);
+      if (editKey) {
+        const setting = findSettingByKey(editKey);
+        if (setting) {
+          editSetting(setting);
+        } else {
+          addSetting(editKey);
+        }
+      }
       enableSaveButton();
     });
   }
@@ -817,18 +861,20 @@
     storeAccessToken();
 
     addListener(document.querySelector("#super-settings-filter"), "input", filterListener);
-    addListener(document.querySelector("#super-settings-add-setting"), "click", addSetting);
+    addListener(document.querySelector("#super-settings-add-setting"), "click", addSettingListener);
     addListener(document.querySelector("#super-settings-discard-changes"), "click", refreshPage);
     addListener(document.querySelector("#super-settings-save-settings"), "click", updateSettings);
     addListener(document.querySelector("#super-settings-modal"), "click", closeModal);
     addListener(document.querySelectorAll(".super-settings-sort-control"), "click", setSortOrder);
 
+    const editKey = fetchEditHash();
+
     const queryParams = new URLSearchParams(window.location.search);
     applyFilter(queryParams.get("filter"));
 
     selectSortElement(document.querySelector(".super-settings-sort-control[data-selected=true]"), true);
 
-    fetchActiveSettings();
+    fetchActiveSettings(editKey);
 
     window.onbeforeunload = promptUnsavedChanges;
   })

data/lib/super_settings/coerce.rb

@@ -7,14 +7,10 @@ module SuperSettings
   class Coerce
     # rubocop:disable Lint/BooleanSymbol
     FALSE_VALUES = Set.new([
-      false, 0,
       "0", :"0",
       "f", :f,
-      "F", :F,
       "false", :false,
-      "FALSE", :FALSE,
-      "off", :off,
-      "OFF", :OFF
+      "off", :off
     ]).freeze
     # rubocop:enable Lint/BooleanSymbol
 
@@ -29,7 +25,7 @@ module SuperSettings
         elsif blank?(value)
           nil
         else
-          !FALSE_VALUES.include?(value)
+          !FALSE_VALUES.include?(value.to_s.downcase)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_settings
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-12 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler