super_settings 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b4e4df83235545b59d31ec20206e265ab19bbe0d4a21de81405bdc7fab892c6
-  data.tar.gz: 8de1f0d4f30714f93f11e1c5b7f004232793676877f2f0396d3fe757cbd2629e
+  metadata.gz: f58b7aa08a4a6082168ff9fa1487f79ff84bf9374b9463d9ba3ebe4e188b6a47
+  data.tar.gz: b4bf73f87885acacc091e3f455a8a33a8b0baa770dd00db42a1fac6b468e5427
 SHA512:
-  metadata.gz: e7d3fa4f5025a6c541fab3f61d906bf1be43e1378c3c88c27d33e726ff18fd3f5d3d3a73c43b11f43945fcc5677eb23ac34fc8f52d66582d755c4a44247454df
-  data.tar.gz: 7b0915ea64422d358d5d93a299c75ee63c620b1d2a476dd15f379c0129ccf67d3760536aaf16798094c1f8c8afa99594b5ace27126d18eaafde004fb30556e44
+  metadata.gz: 973a1ac38488a2cdc4d4cc639f9057d8a1cfd24e216cd7b8cfe4b034af5085b3e0245999b918f3aac7a95416d47fcba46f099d8312afaa2406f63bd5a17f1d25
+  data.tar.gz: e1922327a1c8965dd72d8b11826f398b7dd0cd4f3a3f27be7cc3aa5a81f44da925a159ae2321a122267a9605dd7fbb5fa6af909d4daeeae3cf371087b4df7a7f

data/CHANGELOG.md

@@ -4,6 +4,11 @@ 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]
+
+### Added
+- Optimize object shapes for the Ruby interpreter by declaring instance variables in constructors.
+
 ## [1.0.0]
 
 ### Added

data/README.md

@@ -1,6 +1,7 @@
 # SuperSettings
 
 [![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)
 
 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.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/super_settings/configuration.rb

@@ -22,8 +22,14 @@ module SuperSettings
       # since it will be compatible with class reloading in a development environment.
       attr_writer :superclass
 
+      def initialize
+        @superclass = nil
+        @web_ui_enabled = true
+        @changed_by_block = nil
+      end
+
       def superclass
-        if defined?(@superclass) && @superclass.is_a?(String)
+        if @superclass.is_a?(String)
           @superclass.constantize
         else
           @superclass
@@ -54,9 +60,6 @@ module SuperSettings
       attr_writer :web_ui_enabled
 
       def web_ui_enabled?
-        unless defined?(@web_ui_enabled)
-          @web_ui_enabled = true
-        end
         !!@web_ui_enabled
       end
 
@@ -87,7 +90,7 @@ module SuperSettings
       #
       # @api private
       def changed_by(controller)
-        if defined?(@changed_by_block) && @changed_by_block
+        if @changed_by_block
           controller.instance_eval(&@changed_by_block)
         end
       end
@@ -101,15 +104,19 @@ module SuperSettings
 
       attr_writer :storage
 
+      attr_reader :after_save_blocks, :changed_by_display
+
+      def initialize
+        @storage = :active_record
+        @after_save_blocks = []
+        @changed_by_display = nil
+      end
+
       # Specify the storage engine to use for persisting settings. The value can either be specified
       # as a full class name or an underscored class name for a storage classed defined in the
       # SuperSettings::Storage namespace. The default storage engine is +SuperSettings::Storage::ActiveRecord+.
       def storage
-        if defined?(@storage) && @storage
-          @storage
-        else
-          :active_record
-        end
+        @storage || :active_record
       end
 
       # @return [Class]
@@ -135,12 +142,6 @@ module SuperSettings
         after_save_blocks << block
       end
 
-      # @return [Array<Proc>] The after_save block
-      # @api private
-      def after_save_blocks
-        @after_save_blocks ||= []
-      end
-
       # Define how the changed_by attibute on the setting history will be displayed. The block
       # will be called with the changed_by attribute and should return a string to display.
       # The block will not be called if the changed_by attribute is nil.
@@ -153,12 +154,6 @@ module SuperSettings
       def define_changed_by_display(&block)
         @changed_by_display = block
       end
-
-      # @return [Proc, nil] The block to call to display the changed_by attribute in setting history
-      # @api private
-      def changed_by_display
-        @changed_by_display if defined?(@changed_by_display)
-      end
     end
 
     # Return the model specific configuration object.

data/lib/super_settings/history_item.rb

@@ -9,9 +9,13 @@ module SuperSettings
     attr_accessor :key, :value, :changed_by, :created_at
     attr_writer :deleted
 
+    def initialize(*)
+      @deleted = false
+      super
+    end
+
     def deleted?
-      # Stupid strict mode...
-      !!(defined?(@deleted) && @deleted)
+      !!@deleted
     end
 
     # The display value for the changed_by attribute. This method can be overridden

data/lib/super_settings/setting.rb

@@ -22,6 +22,9 @@ module SuperSettings
 
     ARRAY_DELIMITER = /[\n\r]+/.freeze
 
+    NOT_SET = Object.new.freeze
+    private_constant :NOT_SET
+
     # Exception raised if you try to save with invalid data.
     class InvalidRecordError < StandardError
     end
@@ -33,6 +36,9 @@ module SuperSettings
     # and is cleared after the record is saved.
     attr_accessor :changed_by
 
+    @storage = NOT_SET
+    @after_save_blocks = []
+
     class << self
       # Set a cache to use for caching values. This feature is optional. The cache must respond
       # to +delete(key)+ and +fetch(key, &block)+. If you are running in a Rails environment,
@@ -42,15 +48,19 @@ module SuperSettings
       # Set the storage class to use for persisting data.
       attr_writer :storage
 
+      attr_reader :after_save_blocks
+
       # @return [Class] The storage class to use for persisting data.
       # @api private
       def storage
-        if defined?(@storage)
-          @storage
-        elsif defined?(::SuperSettings::Storage::ActiveRecordStorage)
-          ::SuperSettings::Storage::ActiveRecordStorage
+        if @storage == NOT_SET
+          if defined?(::SuperSettings::Storage::ActiveRecordStorage)
+            ::SuperSettings::Storage::ActiveRecordStorage
+          else
+            raise ArgumentError.new("No storage class defined for #{name}")
+          end
         else
-          raise ArgumentError.new("No storage class defined for #{name}")
+          @storage
         end
       end
 
@@ -63,12 +73,6 @@ module SuperSettings
         after_save_blocks << block
       end
 
-      # @return [Array<Proc>] Blocks to be called after a setting is saved.
-      # @api private
-      def after_save_blocks
-        @after_save_blocks ||= []
-      end
-
       # Create a new setting with the specified attributes.
       #
       # @param attributes [Hash] hash of attribute names and values

data/lib/super_settings/storage/http_storage.rb

@@ -14,6 +14,9 @@ module SuperSettings
       DEFAULT_HEADERS = {"Accept" => "application/json"}.freeze
       DEFAULT_TIMEOUT = 5.0
 
+      @headers = {}
+      @query_params = {}
+
       attr_reader :key, :raw_value, :description, :value_type, :updated_at, :created_at
 
       class Error < StandardError
@@ -36,12 +39,17 @@ module SuperSettings
 
         attr_accessor :key, :value, :changed_by, :deleted
 
+        def initialize(*)
+          @deleted = false
+          super
+        end
+
         def created_at=(val)
           @created_at = SuperSettings::Coerce.time(val)
         end
 
         def deleted?
-          !!(defined?(@deleted) && @deleted)
+          !!@deleted
         end
       end
 
@@ -75,13 +83,9 @@ module SuperSettings
 
         attr_accessor :timeout
 
-        def headers
-          @headers ||= {}
-        end
+        attr_reader :headers
 
-        def query_params
-          @query_params ||= {}
-        end
+        attr_reader :query_params
 
         protected
 
@@ -178,6 +182,12 @@ module SuperSettings
         end
       end
 
+      def initialize(*)
+        @persisted = false
+        @deleted = false
+        super
+      end
+
       def save!
         payload = {key: key}
         if deleted?
@@ -248,11 +258,11 @@ module SuperSettings
       end
 
       def deleted?
-        !!(defined?(@deleted) && @deleted)
+        !!@deleted
       end
 
       def persisted?
-        !!(defined?(@persisted) && @persisted)
+        !!@persisted
       end
 
       private

data/lib/super_settings/storage/redis_storage.rb

@@ -65,6 +65,11 @@ module SuperSettings
           end
         end
 
+        def initialize(*)
+          @deleted = false
+          super
+        end
+
         def created_at=(val)
           @created_at = SuperSettings::Coerce.time(val)
         end
@@ -77,7 +82,7 @@ module SuperSettings
         end
 
         def deleted?
-          !!(defined?(@deleted) && @deleted)
+          !!@deleted
         end
 
         private
@@ -184,6 +189,12 @@ module SuperSettings
         end
       end
 
+      def initialize(*)
+        @deleted = false
+        @persisted = false
+        super
+      end
+
       def history(limit: nil, offset: 0)
         HistoryStorage.find_all_by_key(key: key, limit: limit, offset: offset).collect do |record|
           HistoryItem.new(key: key, value: record.value, changed_by: record.changed_by, created_at: record.created_at, deleted: record.deleted?)
@@ -242,11 +253,11 @@ module SuperSettings
       end
 
       def deleted?
-        !!(defined?(@deleted) && @deleted)
+        !!@deleted
       end
 
       def persisted?
-        !!(defined?(@persisted) && @persisted)
+        !!@persisted
       end
 
       private

data/lib/super_settings/storage/test_storage.rb

@@ -13,13 +13,13 @@ module SuperSettings
       attr_reader :key, :raw_value, :description, :value_type, :updated_at, :created_at
       attr_accessor :changed_by
 
+      @settings = {}
+      @history = {}
+
       class << self
-        def settings
-          @settings ||= {}
-        end
+        attr_reader :settings
 
         def history(key)
-          @history ||= {}
           items = @history[key]
           unless items
             items = []
@@ -68,6 +68,18 @@ module SuperSettings
         end
       end
 
+      def initialize(*)
+        @original_key = nil
+        @raw_value = nil
+        @created_at = nil
+        @updated_at = nil
+        @description = nil
+        @value_type = nil
+        @deleted = false
+        @persisted = false
+        super
+      end
+
       def history(limit: nil, offset: 0)
         items = self.class.history(key)
         items[offset, limit || items.length].collect do |attributes|
@@ -121,11 +133,11 @@ module SuperSettings
       end
 
       def deleted?
-        !!(defined?(@deleted) && @deleted)
+        !!@deleted
       end
 
       def persisted?
-        !!(defined?(@persisted) && @persisted)
+        !!@persisted
       end
 
       private

data/lib/super_settings/storage.rb

@@ -10,6 +10,8 @@ module SuperSettings
     def self.included(base)
       base.extend(ClassMethods)
       base.include(Attributes) unless base.instance_methods.include?(:attributes=)
+
+      base.instance_variable_set(:@load_asynchronous, nil)
     end
 
     module ClassMethods
@@ -76,7 +78,7 @@ module SuperSettings
       #
       # @return [Boolean]
       def load_asynchronous?
-        !!((defined?(@load_asynchronous) && !@load_asynchronous.nil?) ? @load_asynchronous : default_load_asynchronous?)
+        !!(@load_asynchronous.nil? ? default_load_asynchronous? : @load_asynchronous)
       end
 
       # Set to true to force loading setting asynchronously in a background thread.

data/lib/super_settings.rb

@@ -23,6 +23,8 @@ end
 module SuperSettings
   DEFAULT_REFRESH_INTERVAL = 5.0
 
+  @local_cache = LocalCache.new(refresh_interval: DEFAULT_REFRESH_INTERVAL)
+
   class << self
     # Get a setting value cast to a string.
     #
@@ -219,9 +221,7 @@ module SuperSettings
 
     private
 
-    def local_cache
-      @local_cache ||= LocalCache.new(refresh_interval: DEFAULT_REFRESH_INTERVAL)
-    end
+    attr_reader :local_cache
 
     def current_context
       Thread.current[:super_settings_context]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_settings
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-30 00:00:00.000000000 Z
+date: 2023-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler