process_settings 0.13.2 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3825ac379576930a892de053c60a8a5ea108cf18ca231c36afb74d29e023e873
-  data.tar.gz: 9e06cf4895b856fa801f868a5e600023ab27cbbee2a730f8d2c776de6b14ea62
+  metadata.gz: 17af8e8b00a219e790b36fc20282e0c4c7d7c04cfd7f911ea636f056b675cf70
+  data.tar.gz: 198665150f57b95634698ab3474dd587dbefbc48ecf41d10084a6f872a0a3949
 SHA512:
-  metadata.gz: 38a7e49c5782b72c334f9029388ffb06aa94cf3fd7dffc73a7750f102445c21fb8788df60d37af53e68f1e58956ef429cd7a3a442e117095eea74bd89bc2340d
-  data.tar.gz: ac57357cd9873b9a8f42b98046b5ebd942e9058083d0b71711879ea73c917671967ffbc34aa3be77dc3b8b844d6f966a3b13c88860ccc2a7e8a659f1eecad117
+  metadata.gz: ea2bf7c35886a10807a3b8ab171133776c1381371b628ac08cbe413a2cbc8d4bc8c600142fc44c0734fb1e2dc6bb2143be40c68c5b99217404fa6a085ccf2326
+  data.tar.gz: b92dbd32b2935e7d3ba4b8b95f33dc032e018a273505f7daaba4126d1ef7f132fe40e79535780c45a3283df9daa3c006ce1312c2cf2c2eb472b7b123f09fa10f

data/README.md

@@ -169,8 +169,8 @@ The settings YAML files are always combined in alphabetical order by file path.
 
 ### Testing
 For testing, it is often necessary to set a specific override hash for the process_settings values to use in
-that use case.  The `ProcessSettings::Testing::Helpers` module is provided for this purpose.  It can be used to
-override a specific hash of process settings, while leaving the rest intact, and resetting back to the defaults
+that use case.  The `ProcessSettings::Testing::RSpec::Helpers` and `ProcessSettings::Testing::Minitest::Helpers` modules are provided for this purpose.
+They can be used to override a specific hash of process settings, while leaving the rest intact, and resetting back to the defaults
 after the test case is over.  Here are some examples using various testing frameworks:
 
 #### RSpec
@@ -181,7 +181,7 @@ require 'process_settings/testing/helpers'
 RSpec.configure do |config|
   # ...
 
-  include ProcessSettings::Testing::Helpers
+  include ProcessSettings::Testing::RSpec::Helpers
 
   # Note: the include above will automatically register a global after block that will reset process_settings to their initial values.
   # ...
@@ -206,7 +206,7 @@ end
 require 'process_settings/testing/helpers'
 
 context SomeClass do
-  include ProcessSettings::Testing::Helpers
+  include ProcessSettings::Testing::Minitest::Helpers
 
   # Note: the include above will automatically register a teardown block that will reset process_settings to their initial values.
 

data/bin/combine_process_settings

@@ -77,11 +77,11 @@ end
 
 MINIMUM_LIBYAML_VERSION = '0.2.5' # So that null (nil) values don't have trailing spaces.
 
-def check_libyaml_version
+def warn_if_old_libyaml_version
   if Gem::Version.new(Psych::LIBYAML_VERSION) < Gem::Version.new(MINIMUM_LIBYAML_VERSION)
     warn <<~EOS
 
-      #{PROGRAM_NAME} error: libyaml version #{Psych::LIBYAML_VERSION} must be at least #{MINIMUM_LIBYAML_VERSION}. Try:
+      #{PROGRAM_NAME} warning: libyaml version #{Psych::LIBYAML_VERSION} is out of date; it should be at least #{MINIMUM_LIBYAML_VERSION}. On a Mac, try:
 
           brew update && brew upgrade libyaml
 
@@ -89,8 +89,6 @@ def check_libyaml_version
 
           gem install psych -- --enable-bundled-libyaml
     EOS
-
-    exit(1)
   end
 end
 
@@ -101,14 +99,14 @@ end
 
 options = parse_options(ARGV.dup)
 
-check_libyaml_version
+warn_if_old_libyaml_version
 
 combined_settings = read_and_combine_settings(Pathname.new(options.root_folder) + SETTINGS_FOLDER)
 
 version_number = options.version || default_version_number(options.initial_filename)
 combined_settings << end_marker(version_number)
 
-yaml = combined_settings.to_yaml
+yaml = combined_settings.to_yaml.gsub(/: $/, ':') # libyaml before 0.2.5 wrote trailing space for nil
 yaml_with_warning_comment = add_warning_comment(yaml, options.root_folder, PROGRAM_NAME, SETTINGS_FOLDER)
 
 output_filename     = options.output_filename

data/lib/process_settings/abstract_monitor.rb

@@ -11,14 +11,16 @@ module ProcessSettings
   OnChangeDeprecation = ActiveSupport::Deprecation.new('1.0', 'ProcessSettings::Monitor')
 
   class AbstractMonitor
+
     attr_reader :min_polling_seconds, :logger
-    attr_reader :static_context, :statically_targeted_settings
+    attr_reader :static_context, :statically_targeted_settings, :full_context_cache
 
     def initialize(logger:)
       @logger = logger or raise ArgumentError, "logger must be not be nil"
       @on_change_callbacks = []
       @when_updated_blocks = Set.new
       @static_context = {}
+      @full_context_cache = {}
     end
 
     # This is the main entry point for looking up settings on the Monitor instance.
@@ -94,10 +96,20 @@ module ProcessSettings
     def targeted_value(*path, dynamic_context:, required: true)
       # Merging the static context in is necessary to make sure that the static context isn't shifting
       # this can be rather costly to do every time if the dynamic context is not changing
-      # TODO: Warn in the case where dynamic context was attempting to change a static value
-      # TODO: Cache the last used dynamic context as a potential optimization to avoid unnecessary deep merges
-      # TECH-4402 was created to address these todos
-      full_context = dynamic_context.deep_merge(static_context)
+
+      # Warn in the case where dynamic context was attempting to change a static value
+      changes = dynamic_context.each_with_object({}) do |(key, dynamic_value), result|
+        if static_context.has_key?(key)
+          static_value = static_context[key]
+          if static_value != dynamic_value
+            result[key] = [static_value, dynamic_value]
+          end
+        end
+      end
+
+      changes.empty? or warn("WARNING: static context overwritten by dynamic!\n#{changes.inspect}")
+
+      full_context = full_context_from_cache(dynamic_context)
       result = statically_targeted_settings.reduce(:not_found) do |latest_result, target_and_settings|
         # find last value from matching targets
         if target_and_settings.target.target_key_matches?(full_context)
@@ -119,6 +131,22 @@ module ProcessSettings
       end
     end
 
+    def full_context_from_cache(dynamic_context)
+      if (full_context = full_context_cache[dynamic_context])
+        logger.info("cache hit ...")
+        full_context
+      else
+        logger.info("cache miss ...")
+        dynamic_context.deep_merge(static_context).tap do |full_context|
+          if full_context_cache.size <= 1000
+            full_context_cache[dynamic_context] = full_context
+          else
+            logger.info("cache limit reached ...")
+          end
+        end
+      end
+    end
+
     private
 
     class << self

data/lib/process_settings/testing/helpers.rb

@@ -8,48 +8,66 @@ require 'process_settings/testing/monitor'
 
 module ProcessSettings
   module Testing
-    module Helpers
-      class << self
-        def included(including_klass)
-          after_method =
-            if including_klass.respond_to?(:teardown)
-              :teardown
-            else
-              :after
-            end
+    module Base
+      module Helpers
+        # Adds the given settings_hash as an override at the end of the process_settings array, with default targeting (true).
+        # Therefore this will override these settings while leaving others alone.
+        #
+        # @param [Hash] settings_hash
+        #
+        # @return none
+        def stub_process_settings(settings_hash)
+          new_target_and_settings = ProcessSettings::TargetAndSettings.new(
+            '<test_override>',
+            Target::true_target,
+            ProcessSettings::Settings.new(settings_hash.deep_stringify_keys)
+          )
 
-          including_klass.send(after_method) do
-            ProcessSettings.instance = initial_instance
-          end
+          new_process_settings = [
+            *initial_instance.statically_targeted_settings,
+            new_target_and_settings
+          ]
+
+          ProcessSettings.instance = ProcessSettings::Testing::Monitor.new(
+            new_process_settings,
+            logger: initial_instance.logger
+          )
+        end
+
+        def initial_instance
+          @initial_instance ||= ProcessSettings.instance
         end
       end
-      # Adds the given settings_hash as an override at the end of the process_settings array, with default targeting (true).
-      # Therefore this will override these settings while leaving others alone.
-      #
-      # @param [Hash] settings_hash
-      #
-      # @return none
-      def stub_process_settings(settings_hash)
-        new_target_and_settings = ProcessSettings::TargetAndSettings.new(
-          '<test_override>',
-          Target::true_target,
-          ProcessSettings::Settings.new(settings_hash.deep_stringify_keys)
-        )
-
-        new_process_settings = [
-          *initial_instance.statically_targeted_settings,
-          new_target_and_settings
-        ]
-
-        ProcessSettings.instance = ProcessSettings::Testing::Monitor.new(
-          new_process_settings,
-          logger: initial_instance.logger
-        )
+    end
+
+    module RSpec
+      module Helpers
+        include Base::Helpers
+
+        class << self
+          def included(including_klass)
+            including_klass.after do
+              ProcessSettings.instance = initial_instance
+            end
+          end
+        end
       end
+    end
+
+    module Minitest
+      module Helpers
+        include Base::Helpers
 
-      def initial_instance
-        @initial_instance ||= ProcessSettings.instance
+        class << self
+          def included(including_klass)
+            including_klass.define_method(:teardown) do
+              ProcessSettings.instance = initial_instance
+            end
+          end
+        end
       end
     end
+
+    Helpers = RSpec::Helpers  # for backward-compatibility
   end
 end

data/lib/process_settings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProcessSettings
-  VERSION = '0.13.2'
+  VERSION = '0.15.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.15.0
 platform: ruby
 authors:
 - Invoca