super_settings 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f58b7aa08a4a6082168ff9fa1487f79ff84bf9374b9463d9ba3ebe4e188b6a47
-  data.tar.gz: b4bf73f87885acacc091e3f455a8a33a8b0baa770dd00db42a1fac6b468e5427
+  metadata.gz: 56ed02dddf10d95bcb20863a4c5918c0396ac510de6815d5ebfdc8d4f7de2847
+  data.tar.gz: 0f2f7d2ae0cbf5948b2d1683b374fbc865e7aaa6a87a1f7e30d73870dc2eac42
 SHA512:
-  metadata.gz: 973a1ac38488a2cdc4d4cc639f9057d8a1cfd24e216cd7b8cfe4b034af5085b3e0245999b918f3aac7a95416d47fcba46f099d8312afaa2406f63bd5a17f1d25
-  data.tar.gz: e1922327a1c8965dd72d8b11826f398b7dd0cd4f3a3f27be7cc3aa5a81f44da925a159ae2321a122267a9605dd7fbb5fa6af909d4daeeae3cf371087b4df7a7f
+  metadata.gz: 6972f850704fd153fec84125c801e3c10627a0d4cc2cde1c3f15274d2cef7867239999aba2f95e83bbf452abc5dd6db9a264b322e46d3fb17673d34cbf362db1
+  data.tar.gz: 3889cb5652b9fd01b6e31a512fa9919bab40abad9d4e5367058c045eb406425d988aab2617a2d148a8bf669340d2839c07225a9d3c5e768a02807f191c24ec26

data/CHANGELOG.md

@@ -4,12 +4,22 @@ 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).
 
-## [1.0.1]
+## 1.0.2
+
+### Added
+
+- Added SuperSetting.rand method that can return a consistent random number inside of a context block.
+
+### Changed
+
+- Lazy load non-required classes.
+
+## 1.0.1
 
 ### Added
 - Optimize object shapes for the Ruby interpreter by declaring instance variables in constructors.
 
-## [1.0.0]
+## 1.0.0
 
 ### Added
 - Everything!

data/README.md

@@ -3,6 +3,7 @@
 [![Continuous Integration](https://github.com/bdurand/super_settings/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/super_settings/actions/workflows/continuous_integration.yml)
 [![Regression Test](https://github.com/bdurand/super_settings/actions/workflows/regression_test.yml/badge.svg)](https://github.com/bdurand/super_settings/actions/workflows/regression_test.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/super_settings.svg)](https://badge.fury.io/rb/super_settings)
 
 This gem provides a framework for maintaining runtime application settings. Settings are persisted in a database but cached in memory for quick, efficient access. The settings are designed so they can be updated dynamically without requiring code deployment or restarting processes. The code scales very well and can easily handle very high throughput environments.
 
@@ -102,6 +103,16 @@ SuperSettings.context do
 end
 ```
 
+You can also use the `SuperSettings.rand` method inside a context block to return a consistent random number. This can be useful for things like feature flags that you want to turn on for only a percentage of requests:
+
+```ruby
+def enabled?
+  SuperSettings.float("feature_rollout_percent") <= SuperSettings.rand
+end
+```
+
+Now the value of `enabled?` will always return the same value inside of a context block. It will still be random if it is enabled for each context block.
+
 It's a good idea to add a `context` block around your main unit of work:
 
 - Rack application: add `SuperSettings::Context::RackMiddleware` to your middleware stack

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/lib/super_settings/attributes.rb

@@ -13,8 +13,8 @@ module SuperSettings
 
     def attributes=(values)
       values.each do |name, value|
-        if respond_to?("#{name}=", true)
-          send("#{name}=", value)
+        if respond_to?(:"#{name}=", true)
+          send(:"#{name}=", value)
         else
           raise UnknownAttributeError.new("unknown attribute #{name.to_s.inspect} for #{self.class}")
         end

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/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)

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|

data/lib/super_settings/setting.rb

@@ -54,7 +54,7 @@ module SuperSettings
       # @api private
       def storage
         if @storage == NOT_SET
-          if defined?(::SuperSettings::Storage::ActiveRecordStorage)
+          if defined?(ActiveRecord) && defined?(::SuperSettings::Storage::ActiveRecordStorage)
             ::SuperSettings::Storage::ActiveRecordStorage
           else
             raise ArgumentError.new("No storage class defined for #{name}")

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SuperSettings
+  module Storage
+    class ActiveRecordStorage
+      # Base class that the models extend from.
+      class ApplicationRecord < ActiveRecord::Base
+        self.abstract_class = true
+      end
+
+      class Model < ApplicationRecord
+        self.table_name = "super_settings"
+
+        has_many :history_items, class_name: "SuperSettings::Storage::ActiveRecordStorage::HistoryModel", foreign_key: :key, primary_key: :key
+      end
+
+      class HistoryModel < ApplicationRecord
+        self.table_name = "super_settings_histories"
+
+        # Since these models are created automatically on a callback, ensure that the data will
+        # fit into the database columns since we can't handle any validation errors.
+        before_validation do
+          self.changed_by = changed_by.to_s[0, 150] if changed_by.present?
+        end
+      end
+    end
+  end
+end

data/lib/super_settings/storage/active_record_storage.rb

@@ -10,26 +10,9 @@ module SuperSettings
     # @example
     #   rake app:super_settings:install:migrations
     class ActiveRecordStorage
-      # Base class that the models extend from.
-      class ApplicationRecord < ActiveRecord::Base
-        self.abstract_class = true
-      end
-
-      class Model < ApplicationRecord
-        self.table_name = "super_settings"
-
-        has_many :history_items, class_name: "SuperSettings::Storage::ActiveRecordStorage::HistoryModel", foreign_key: :key, primary_key: :key
-      end
-
-      class HistoryModel < ApplicationRecord
-        self.table_name = "super_settings_histories"
-
-        # Since these models are created automatically on a callback, ensure that the data will
-        # fit into the database columns since we can't handle any validation errors.
-        before_validation do
-          self.changed_by = changed_by.to_s[0, 150] if changed_by.present?
-        end
-      end
+      autoload :ApplicationRecord, File.join(__dir__, "active_record_storage/models")
+      autoload :Model, File.join(__dir__, "active_record_storage/models")
+      autoload :HistoryModel, File.join(__dir__, "active_record_storage/models")
 
       include Storage
 

data/lib/super_settings/storage/redis_storage.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "json"
+require "redis"
 
 module SuperSettings
   module Storage

data/lib/super_settings/storage.rb

@@ -4,6 +4,10 @@ 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 :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
 
@@ -272,10 +276,8 @@ end
 require_relative "storage/http_storage"
 require_relative "storage/redis_storage"
 if defined?(ActiveSupport) && ActiveSupport.respond_to?(:on_load)
-  ActiveSupport.on_load(:active_record) do
+  ActiveSupport.on_load(:active_record_base) do
     require_relative "storage/active_record_storage"
   end
-elsif defined?(ActiveRecord::Base)
-  require_relative "storage/active_record_storage"
 end
 # :nocov:

data/lib/super_settings.rb

@@ -1,26 +1,24 @@
 # frozen_string_literal: true
 
-require_relative "super_settings/application"
+# These classes are required for the gem to function.
+require_relative "super_settings/attributes"
 require_relative "super_settings/coerce"
 require_relative "super_settings/configuration"
 require_relative "super_settings/context"
-require_relative "super_settings/context/rack_middleware"
 require_relative "super_settings/local_cache"
-require_relative "super_settings/rest_api"
-require_relative "super_settings/rack_application"
-require_relative "super_settings/controller_actions"
-require_relative "super_settings/attributes"
 require_relative "super_settings/setting"
-require_relative "super_settings/history_item"
 require_relative "super_settings/storage"
-require_relative "super_settings/version"
-
-if defined?(Rails::Engine)
-  require_relative "super_settings/engine"
-end
 
 # This is the main interface to the access settings.
 module SuperSettings
+  # These classes are autoloaded when they are needed.
+  autoload :Application, "super_settings/application"
+  autoload :RestAPI, "super_settings/rest_api"
+  autoload :RackApplication, "super_settings/rack_application"
+  autoload :ControllerActions, "super_settings/controller_actions"
+  autoload :HistoryItem, "super_settings/history_item"
+  autoload :VERSION, "super_settings/version"
+
   DEFAULT_REFRESH_INTERVAL = 5.0
 
   @local_cache = LocalCache.new(refresh_interval: DEFAULT_REFRESH_INTERVAL)
@@ -105,6 +103,28 @@ module SuperSettings
       Array(val).collect { |v| v&.to_s }
     end
 
+    # Get a pseudo random number. This method works the same as Kernel.rand. However, if you are
+    # inside a context block, then the random number will be the same each time you call this method.
+    # This is useful when you need to generate a random number for a setting that you want to remain
+    # constant for the duration of the block.
+    #
+    # So, for instance, if you are generating a random number to determine if a feature is enabled,
+    # you can use this method to ensure that the feature is either always enabled or always disabled
+    # for the duration of the block.
+    #
+    # @param max [Integer, Float, Range] the maximum value or range to use for the random number
+    # @return [Integer, Float] the random number. It will be an integer if max is an integer, otherwise
+    #   it will be a float.
+    def rand(max = nil)
+      max ||= 1.0
+      context = current_context
+      if context
+        context.rand(max)
+      else
+        Random.rand(max)
+      end
+    end
+
     # Create settings and update the local cache with the values. If a block is given, then the
     # value will be reverted at the end of the block. This method can be used in tests when you
     # need to inject a specific value into your settings.
@@ -148,7 +168,7 @@ module SuperSettings
     def context(&block)
       reset_context = Thread.current[:super_settings_context].nil?
       begin
-        Thread.current[:super_settings_context] ||= {}
+        Thread.current[:super_settings_context] ||= Context::Current.new
         yield
       ensure
         Thread.current[:super_settings_context] = nil if reset_context
@@ -241,3 +261,7 @@ module SuperSettings
     end
   end
 end
+
+if defined?(Rails::Engine)
+  require_relative "super_settings/engine"
+end

data/super_settings.gemspec

@@ -4,10 +4,17 @@ Gem::Specification.new do |spec|
   spec.authors = ["Brian Durand"]
   spec.email = ["bbdurand@gmail.com"]
 
-  spec.summary = "Fast access runtime settings for a Rails application with an included UI and API for administration."
+  spec.summary = "Fast access runtime settings for applications with an included UI and API for administration."
+
   spec.homepage = "https://github.com/bdurand/super_settings"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   ignore_files = %w[

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_settings
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-11 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,7 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- MIT-LICENSE
+- MIT-LICENSE.txt
 - README.md
 - VERSION
 - app/helpers/super_settings/settings_helper.rb
@@ -57,6 +57,7 @@ files:
 - lib/super_settings/coerce.rb
 - lib/super_settings/configuration.rb
 - lib/super_settings/context.rb
+- lib/super_settings/context/current.rb
 - lib/super_settings/context/rack_middleware.rb
 - lib/super_settings/context/sidekiq_middleware.rb
 - lib/super_settings/controller_actions.rb
@@ -68,6 +69,7 @@ files:
 - lib/super_settings/setting.rb
 - 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/http_storage.rb
 - lib/super_settings/storage/redis_storage.rb
 - lib/super_settings/storage/test_storage.rb
@@ -76,7 +78,10 @@ files:
 homepage: https://github.com/bdurand/super_settings
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/bdurand/super_settings
+  source_code_uri: https://github.com/bdurand/super_settings
+  changelog_uri: https://github.com/bdurand/super_settings/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -92,9 +97,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Fast access runtime settings for a Rails application with an included UI
-  and API for administration.
+summary: Fast access runtime settings for applications with an included UI and API
+  for administration.
 test_files: []