super_settings 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f33b56ee26912045f574c3ec5d6e0bd9ddd283517ebcb7f7ed96173b83cc745
-  data.tar.gz: 2a585b3400896dc3f502550a56f37761a588f23cb2504e72fe5e41fbe42bfa25
+  metadata.gz: c245924ff453f5cd0bde098003e6dc05d54b21aba4a42ddaf7c614c63233a542
+  data.tar.gz: fb8672624d5c688794f8492be263534ed4e46ac49684f76d9bbf3bd120b62579
 SHA512:
-  metadata.gz: 54cf6302e4c2e760b945e829bfaa8b289f920e7a2d794ddcd711ff4bf4683e9c5ef5eb0b6275f62f2927ecd28b5dcd6f5575809acda291eef3f177a66738a28a
-  data.tar.gz: 8019ec60d65105961f9d7bc6cb0db0e1e740a298d02c4e99106cebc34bbe1dff7a0f5b32f89a798bd0d2a9f36dc117fc192bd8468b871f535851b8f2d4b5f077
+  metadata.gz: 605db9f00bbd1865203caaf7515c3d5f1ad83911653dd9410c69344dda0b21b8e58167806186969a6d2b27d4867a61d97b29333715c3f139741f16a3d3b0a635
+  data.tar.gz: b1565e3ace970a26a8d126ec27e3bee6786b5da85e33e25bbde5a947af12e8067a23d143870b7012dd449b86ab5658fbeb99fb365bc8f738276cf8672ffc318d

data/CHANGELOG.md

@@ -4,6 +4,16 @@ 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.1
+
+### Fixed
+
+- Added check to ensure that ActiveRecord has a connection to the database to avoid error when settings are checked before the database is connected or when the database doesn't yet exist.
+
+### Added
+
+- Added `:null` storage engine that doesn't store settings at all. This is useful for testing or when the storage engine is no available in your continuous integration environment.
+
 ## 2.1.0
 
 ## Fixed

data/README.md

@@ -154,6 +154,8 @@ This gem abstracts out the storage engine and can support multiple storage mecha
 * `SuperSettings::Storage::RedisStorage` - Stores the settings in a Redis database using the [redis](https://github.com/redis/redis-rb) gem.
 * `SuperSettings::Storage::HttpStorage` - Uses the SuperSettings REST API running on another server. This is useful in a microservices architecture so you can have a central settings server used by all the services.
 * `SuperSettings::Storage::S3Storage` - Stores the settings in JSON in an S3 object. This is useful for applications running on AWS that want to store settings in a central location since it does not require a dedicated database. It is possible to read the settings directly from S3 from another application.
+* `SuperSettings::Storage::MongoDBStorage` - Stores the settings in a MongoDB database using the [mongo](https://github.com/mongodb/mongo-ruby-driver) gem.
+* `SuperSettings::Storage::NullStorage` - Does not store settings at all. This is useful for testing or when the storage engine is not available in your continuous integration environment.
 
 Additional storage engines can be built by creating a class that includes `SuperSettings::Storage` and implements the unimplemented methods in that module.
 
@@ -391,10 +393,12 @@ bundle exec rackup
 
 By default this will use Redis for storage using the default Redis URL. You can change the storage engine with the `STORAGE` environment variable.
 
+- `active_record` - Use the ActiveRecord storage engine.
 - `redis` - Use the Redis storage engine. The Redis URL can be set with the `REDIS_URL` environment variable.
 - `http` - Use the HTTP storage engine. The URL for the REST API can be set with the `REST_API_URL` environment variable.
 - `s3` - Use the S3 storage engine. The S3 URL can be set with the `S3_URL` environment variable.
 - `mongodb` - Use the MongoDB storage engine. The MongoDB URL can be set with the `MONGODB_URL` environment variable.
+- `null` - Use the null storage engine. This storage engine does not store settings at all.
 
 You can bring up all of these storage engines locally with the included docker-compose configuration.
 

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.1.1

data/lib/super_settings/configuration.rb

@@ -27,6 +27,10 @@ module SuperSettings
         @web_ui_enabled = true
         @color_scheme = false
         @changed_by_block = nil
+        @enhancement = nil
+        @application_name = nil
+        @application_logo = nil
+        @application_link = nil
       end
 
       def superclass
@@ -119,6 +123,7 @@ module SuperSettings
         @storage = :active_record
         @after_save_blocks = []
         @changed_by_display = nil
+        @cache = nil
       end
 
       # Specify the storage engine to use for persisting settings. The value can either be specified

data/lib/super_settings/storage/active_record_storage/models.rb

@@ -12,6 +12,13 @@ module SuperSettings
         self.table_name = "super_settings"
 
         has_many :history_items, class_name: "SuperSettings::Storage::ActiveRecordStorage::HistoryModel", foreign_key: :key, primary_key: :key
+
+        class << self
+          # ActiveRecord storage is only available if the connection pool is connected and the table exists.
+          def available?
+            connection_pool&.connected? && table_exists?
+          end
+        end
       end
 
       class HistoryModel < ApplicationRecord

data/lib/super_settings/storage/active_record_storage.rb

@@ -18,7 +18,7 @@ module SuperSettings
 
       class << self
         def all
-          if Model.table_exists?
+          if Model.available?
             Model.all.collect { |model| new(model) }
           else
             []
@@ -26,7 +26,7 @@ module SuperSettings
         end
 
         def active
-          if Model.table_exists?
+          if Model.available?
             Model.where(deleted: false).collect { |model| new(model) }
           else
             []
@@ -34,7 +34,7 @@ module SuperSettings
         end
 
         def updated_since(time)
-          if Model.table_exists?
+          if Model.available?
             Model.where("updated_at > ?", time).collect { |model| new(model) }
           else
             []
@@ -42,12 +42,12 @@ module SuperSettings
         end
 
         def find_by_key(key)
-          model = Model.where(deleted: false).find_by(key: key) if Model.table_exists?
+          model = Model.where(deleted: false).find_by(key: key) if Model.available?
           new(model) if model
         end
 
         def last_updated_at
-          if Model.table_exists?
+          if Model.available?
             Model.maximum(:updated_at)
           end
         end

data/lib/super_settings/storage/null_storage.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module SuperSettings
+  module Storage
+    # No-op implementation of the SuperSettings::Storage model. You can use this model if there
+    # is no other storage engine available. It can be useful for situations where the normal
+    # storage engine is not available, such as in a continious integration environment.
+    class NullStorage
+      # :nocov:
+
+      include Storage
+
+      attr_accessor :key, :raw_value, :description, :value_type, :updated_at, :created_at, :changed_by
+
+      class << self
+        attr_reader :settings
+
+        def history(key)
+          []
+        end
+
+        def destroy_all
+        end
+
+        def all
+          []
+        end
+
+        def updated_since(time)
+          []
+        end
+
+        def find_by_key(key)
+          nil
+        end
+
+        def last_updated_at
+          nil
+        end
+
+        def create_history(key:, changed_by:, created_at:, value: nil, deleted: false)
+          nil
+        end
+
+        def load_asynchronous?
+          false
+        end
+      end
+
+      def history(limit: nil, offset: 0)
+        []
+      end
+
+      def save!
+        true
+      end
+
+      def deleted=(value)
+      end
+
+      def deleted?
+        false
+      end
+
+      def persisted?
+        false
+      end
+
+      # :nocov:
+    end
+  end
+end

data/lib/super_settings/storage.rb

@@ -13,6 +13,7 @@ module SuperSettings
     autoload :JSONStorage, File.join(__dir__, "storage/json_storage")
     autoload :S3Storage, File.join(__dir__, "storage/s3_storage")
     autoload :MongoDBStorage, File.join(__dir__, "storage/mongodb_storage")
+    autoload :NullStorage, File.join(__dir__, "storage/null_storage")
 
     def self.included(base)
       base.extend(ClassMethods)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_settings
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-22 00:00:00.000000000 Z
+date: 2024-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,7 @@ files:
 - lib/super_settings/storage/http_storage.rb
 - lib/super_settings/storage/json_storage.rb
 - lib/super_settings/storage/mongodb_storage.rb
+- lib/super_settings/storage/null_storage.rb
 - lib/super_settings/storage/redis_storage.rb
 - lib/super_settings/storage/s3_storage.rb
 - lib/super_settings/storage/storage_attributes.rb