super_settings 1.0.2 → 2.0.0

data/lib/super_settings/storage/storage_attributes.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module SuperSettings
+  module Storage
+    # Generic class that can be extended to represent a setting in memory.
+    class StorageAttributes
+      include SuperSettings::Storage
+
+      attr_reader :key, :raw_value, :description, :value_type, :updated_at, :created_at
+
+      def initialize(attributes = nil)
+        @key = nil
+        @raw_value = nil
+        @description = nil
+        @value_type = nil
+        @deleted = false
+        @updated_at = nil
+        @created_at = nil
+        @persisted = false
+        super
+      end
+
+      def key=(value)
+        @key = (Coerce.blank?(value) ? nil : value.to_s)
+      end
+
+      def raw_value=(value)
+        @raw_value = (Coerce.blank?(value) ? nil : value.to_s)
+      end
+
+      def value_type=(value)
+        @value_type = (Coerce.blank?(value) ? nil : value.to_s)
+      end
+
+      def description=(value)
+        @description = (Coerce.blank?(value) ? nil : value.to_s)
+      end
+
+      def updated_at=(value)
+        @updated_at = SuperSettings::Coerce.time(value)
+      end
+
+      def created_at=(value)
+        @created_at = SuperSettings::Coerce.time(value)
+      end
+
+      def deleted?
+        !!@deleted
+      end
+
+      def deleted=(val)
+        @deleted = !!val
+      end
+
+      def persisted?
+        !!@persisted
+      end
+
+      def persisted=(val)
+        @persisted = !!val
+      end
+    end
+  end
+end

data/lib/super_settings/storage/test_storage.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "json"
-
 module SuperSettings
   module Storage
     # Implementation of the SuperSettings::Storage model for running unit tests.
@@ -28,7 +26,7 @@ module SuperSettings
           items
         end
 
-        def clear
+        def destroy_all
           @settings = {}
           @history = {}
         end
@@ -42,7 +40,7 @@ module SuperSettings
         end
 
         def updated_since(time)
-          settings.values.select { |attributes| attributes[:updated_at].to_f >= time.to_f }.collect do |attributes|
+          settings.values.select { |attributes| attributes[:updated_at].to_f > time.to_f }.collect do |attributes|
             setting = new(attributes)
             setting.send(:set_persisted!)
             setting
@@ -54,7 +52,7 @@ module SuperSettings
           return nil unless attributes
           setting = new(attributes)
           setting.send(:set_persisted!)
-          setting
+          setting unless setting.deleted?
         end
 
         def last_updated_at

data/lib/super_settings/storage/transaction.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module SuperSettings
+  module Storage
+    # This module provides support for transactions in storage models that don't natively
+    # support transactions.
+    module Transaction
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def transaction(&block)
+          if Thread.current[transaction_key]
+            yield Thread.current[transaction_key]
+          else
+            begin
+              changes = []
+              Thread.current[transaction_key] = changes
+
+              yield(changes)
+
+              if save_all(changes) != false
+                changes.each do |object|
+                  object.persisted = true if object.respond_to?(:persisted=)
+                end
+              end
+            ensure
+              Thread.current[transaction_key] = nil
+            end
+          end
+        end
+
+        def save_all(changes)
+          # :nocov:
+          raise NotImplementedError
+          # :nocov:
+        end
+
+        private
+
+        def transaction_key
+          "#{name}.transaction"
+        end
+      end
+
+      def persisted=(value)
+        @persisted = Coerce.boolean(value)
+      end
+
+      def persisted?
+        !!@persisted
+      end
+
+      def save!
+        self.updated_at ||= Time.now
+        self.created_at ||= updated_at
+
+        self.class.transaction do |changes|
+          changes << self
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/super_settings/storage.rb

@@ -4,12 +4,15 @@ module SuperSettings
   # Abstraction over how a setting is stored and retrieved from the storage engine. Models
   # must implement the methods module in this module that raise NotImplementedError.
   module Storage
+    autoload :StorageAttributes, File.join(__dir__, "storage/storage_attributes")
+    autoload :HistoryAttributes, File.join(__dir__, "storage/history_attributes")
+    autoload :Transaction, File.join(__dir__, "storage/transaction")
     autoload :ActiveRecordStorage, File.join(__dir__, "storage/active_record_storage")
     autoload :HttpStorage, File.join(__dir__, "storage/http_storage")
     autoload :RedisStorage, File.join(__dir__, "storage/redis_storage")
-
-    class RecordInvalid < StandardError
-    end
+    autoload :JSONStorage, File.join(__dir__, "storage/json_storage")
+    autoload :S3Storage, File.join(__dir__, "storage/s3_storage")
+    autoload :MongoDBStorage, File.join(__dir__, "storage/mongodb_storage")
 
     def self.included(base)
       base.extend(ClassMethods)
@@ -88,6 +91,11 @@ module SuperSettings
       # Set to true to force loading setting asynchronously in a background thread.
       attr_writer :load_asynchronous
 
+      # Implementing classes can override this method to delete all settings. This is used
+      # for testing purposes.
+      def destroy_all
+      end
+
       protected
 
       # Implementing classes can override this method to indicate if it is safe to load the
@@ -155,6 +163,7 @@ module SuperSettings
     end
 
     # The description for the setting.
+    #
     # @return [String]
     def description
       # :nocov:
@@ -163,7 +172,7 @@ module SuperSettings
     end
 
     # Set the description for the setting.
-
+    #
     # @param val [String]
     # @return [void]
     def description=(val)
@@ -273,8 +282,6 @@ module SuperSettings
 end
 
 # :nocov:
-require_relative "storage/http_storage"
-require_relative "storage/redis_storage"
 if defined?(ActiveSupport) && ActiveSupport.respond_to?(:on_load)
   ActiveSupport.on_load(:active_record_base) do
     require_relative "storage/active_record_storage"

data/lib/super_settings/time_precision.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SuperSettings
+  # Helper class for truncating timestamps to a specific precision. This is used by storage engines
+  # to ensure that timestamps are stored and compared with the same precision.
+  class TimePrecision
+    attr_reader :time
+
+    def initialize(time, precision = :microsecond)
+      raise ArgumentError.new("Invalid precision: #{precision}") unless valid_precision?(precision)
+
+      @time = time_with_precision(time.to_f, precision) if time
+    end
+
+    def to_f
+      @time.to_f
+    end
+
+    private
+
+    def valid_precision?(precision)
+      [:microsecond, :millisecond].include?(precision)
+    end
+
+    def time_with_precision(timestamp, precision)
+      usec = (timestamp % 1) * 1_000_000.0
+      if precision == :millisecond
+        milliseconds = (usec / 1000.0).round(3).floor
+        Time.at(timestamp.to_i, milliseconds, :millisecond).utc
+      else
+        microseconds = usec.round
+        Time.at(timestamp.to_i, microseconds, :microsecond).utc
+      end
+    end
+  end
+end

data/lib/super_settings.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "json"
+
 # These classes are required for the gem to function.
 require_relative "super_settings/attributes"
 require_relative "super_settings/coerce"
@@ -8,6 +10,7 @@ require_relative "super_settings/context"
 require_relative "super_settings/local_cache"
 require_relative "super_settings/setting"
 require_relative "super_settings/storage"
+require_relative "super_settings/time_precision"
 
 # This is the main interface to the access settings.
 module SuperSettings
@@ -17,6 +20,7 @@ module SuperSettings
   autoload :RackApplication, "super_settings/rack_application"
   autoload :ControllerActions, "super_settings/controller_actions"
   autoload :HistoryItem, "super_settings/history_item"
+  autoload :HttpClient, "super_settings/http_client"
   autoload :VERSION, "super_settings/version"
 
   DEFAULT_REFRESH_INTERVAL = 5.0
@@ -221,6 +225,13 @@ module SuperSettings
       end
     end
 
+    # Return the configuration object.
+    #
+    # @return [SuperSettings::Configuration]
+    def configuration
+      Configuration.instance
+    end
+
     # Set the number of seconds between checks to synchronize the in memory cache from the database.
     # This setting aids in performance since it throttles the number of times the database is queried
     # for changes. However, changes made to the settings in the databae will take up to the number of

data/super_settings.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Brian Durand"]
   spec.email = ["bbdurand@gmail.com"]
 
-  spec.summary = "Fast access runtime settings for applications with an included UI and API for administration."
+  spec.summary = "SuperSettings provides a scalable framework for managing dynamic runtime application settings with in-memory caching, strong typing, a built-in web UI, and support for multiple storage backends."
 
   spec.homepage = "https://github.com/bdurand/super_settings"
   spec.license = "MIT"
@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
     Gemfile
     Gemfile.lock
     Rakefile
+    docker-compose.yml
+    config.ru
     assets/
     bin/
     gemfiles/
@@ -36,5 +38,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler"
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_settings
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.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
@@ -43,15 +43,19 @@ files:
 - lib/super_settings/application.rb
 - lib/super_settings/application/api.js
 - lib/super_settings/application/helper.rb
-- lib/super_settings/application/images/edit.svg
-- lib/super_settings/application/images/info.svg
+- lib/super_settings/application/images/arrow-down-short.svg
+- lib/super_settings/application/images/arrow-up-short.svg
+- lib/super_settings/application/images/info-circle.svg
+- lib/super_settings/application/images/pencil-square.svg
 - lib/super_settings/application/images/plus.svg
-- lib/super_settings/application/images/slash.svg
-- lib/super_settings/application/images/trash.svg
+- lib/super_settings/application/images/trash3.svg
+- lib/super_settings/application/images/x-circle.svg
 - lib/super_settings/application/index.html.erb
 - lib/super_settings/application/layout.html.erb
 - lib/super_settings/application/layout_styles.css
+- lib/super_settings/application/layout_vars.css.erb
 - lib/super_settings/application/scripts.js
+- lib/super_settings/application/style_vars.css.erb
 - lib/super_settings/application/styles.css
 - lib/super_settings/attributes.rb
 - lib/super_settings/coerce.rb
@@ -63,6 +67,7 @@ files:
 - lib/super_settings/controller_actions.rb
 - lib/super_settings/engine.rb
 - lib/super_settings/history_item.rb
+- lib/super_settings/http_client.rb
 - lib/super_settings/local_cache.rb
 - lib/super_settings/rack_application.rb
 - lib/super_settings/rest_api.rb
@@ -70,9 +75,16 @@ files:
 - lib/super_settings/storage.rb
 - lib/super_settings/storage/active_record_storage.rb
 - lib/super_settings/storage/active_record_storage/models.rb
+- lib/super_settings/storage/history_attributes.rb
 - 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/redis_storage.rb
+- lib/super_settings/storage/s3_storage.rb
+- lib/super_settings/storage/storage_attributes.rb
 - lib/super_settings/storage/test_storage.rb
+- lib/super_settings/storage/transaction.rb
+- lib/super_settings/time_precision.rb
 - lib/super_settings/version.rb
 - super_settings.gemspec
 homepage: https://github.com/bdurand/super_settings
@@ -90,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -100,6 +112,7 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Fast access runtime settings for applications with an included UI and API
-  for administration.
+summary: SuperSettings provides a scalable framework for managing dynamic runtime
+  application settings with in-memory caching, strong typing, a built-in web UI, and
+  support for multiple storage backends.
 test_files: []

data/lib/super_settings/application/images/edit.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit"><path d="M11 4H4a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7"></path><path d="M18.5 2.5a2.121 2.121 0 0 1 3 3L12 15l-4 1 1-4 9.5-9.5z"></path></svg>

data/lib/super_settings/application/images/info.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-info"><circle cx="12" cy="12" r="10"></circle><line x1="12" y1="16" x2="12" y2="12"></line><line x1="12" y1="8" x2="12.01" y2="8"></line></svg>

data/lib/super_settings/application/images/slash.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-slash"><circle cx="12" cy="12" r="10"></circle><line x1="4.93" y1="4.93" x2="19.07" y2="19.07"></line></svg>

data/lib/super_settings/application/images/trash.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-trash-2"><polyline points="3 6 5 6 21 6"></polyline><path d="M19 6v14a2 2 0 0 1-2 2H7a2 2 0 0 1-2-2V6m3 0V4a2 2 0 0 1 2-2h4a2 2 0 0 1 2 2v2"></path><line x1="10" y1="11" x2="10" y2="17"></line><line x1="14" y1="11" x2="14" y2="17"></line></svg>