process_settings 0.13.3.pre.1 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5deb78cad7b19dfbdf5690d0c141a99281b9acb76d83afb1b3a3c4462d9be0d1
-  data.tar.gz: 195cd80b52702c33e97533447022148a33d7c03e6c7525654d86bf71298a45c1
+  metadata.gz: 37586770d262584d6b5f6b2b4a8a7824eb351d9da15d6577dc0591223c0074f0
+  data.tar.gz: 8c61aa64d76749381c1311f7c08f2778a0c99134778c09d45aebd32d1ca10ff5
 SHA512:
-  metadata.gz: 43e042004e010c603b3bb63c55ab9e00dd7ef52809ecf5c7da7abac83a5a82c9ec6f15de118c051f737ba1aaeb0990bb8111cf6c1f31ceabcfc60c2c78f3f520
-  data.tar.gz: 2adf52ea2cd89a9d675aee0304b0cc5bdadae7ceabe3b5093d88830f20f70f4ecb61f720f34c5e5f97fad46a7bb9339ff0e3c4e076435e744d5d8cac97be2f5f
+  metadata.gz: 212169ce11e8ce4c15f056ffc14c15de1e46fadbc93878c922a577b44217bc8c84d3ecfa49773580bbbf06bdae4cb9a58caf55e570c334282e14ed26c9045ff6
+  data.tar.gz: 7afc6259634fba9c6a8e0ebe63ab4ffa361c79fdfb5dde63d4f39168222cb790cfa706989e43eaee5ea7b0f9625d393f4411b673bff68e11e0e609c694372adc

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
+  config.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,11 +89,29 @@ def check_libyaml_version
 
           gem install psych -- --enable-bundled-libyaml
     EOS
-
-    exit(1)
   end
 end
 
+def settings_files_match?(filename_1, filename_2)
+  filename_1 && filename_2 &&
+    File.exist?(filename_1) && File.exist?(filename_2) &&
+    diff_process_settings(filename_1, filename_2)
+end
+
+def diff_process_settings(filename_1, filename_2)
+  system(<<~EOS)
+    bundle exec diff_process_settings --silent "#{filename_1}" "#{filename_2}"
+  EOS
+  status_code = $?.exitstatus
+  case status_code
+  when 0
+    true
+  when 1
+    false
+  else
+    raise "diff_process_settings failed with code #{status_code}"
+  end
+end
 
 #
 # main
@@ -101,14 +119,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
@@ -117,14 +135,17 @@ tmp_output_filename = "#{output_filename}.tmp"
 system("rm -f #{tmp_output_filename}")
 File.write(tmp_output_filename, yaml_with_warning_comment)
 
-system(<<~EOS)
-  if bundle exec diff_process_settings --silent #{tmp_output_filename} #{output_filename} ; then
-    #{"echo #{options.root_folder}: unchanged;" if options.verbose}
-    rm -f #{tmp_output_filename};
+if settings_files_match?(options.initial_filename, tmp_output_filename)
+  if settings_files_match?(output_filename, tmp_output_filename)
+    puts "#{options.root_folder}: unchanged" if options.verbose
+    FileUtils.rm_f(tmp_output_filename)
   else
-    #{"echo #{options.root_folder}: UPDATING;" if options.verbose}
-    mv #{tmp_output_filename} #{output_filename};
-  fi
-EOS
+    puts "#{options.root_folder}: UPDATING (changed now)" if options.verbose
+    FileUtils.mv(tmp_output_filename, output_filename)
+  end
+else
+  puts "#{options.root_folder}: UPDATING (unchanged now, but changed from initial)" if options.verbose
+  FileUtils.mv(tmp_output_filename, output_filename)
+end
 
 exit(0)

data/bin/diff_process_settings

@@ -34,10 +34,7 @@ input_files =
       if path == '-'
         ''
       else
-        unless File.exists?(path)
-          warn "#{path} not found--must be a path to combined_process_settings.yml"
-          exit 1
-        end
+        File.exist?(path) or path = '/dev/null'
         "< #{path}"
       end
     end

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,47 +8,66 @@ require 'process_settings/testing/monitor'
 
 module ProcessSettings
   module Testing
-    module Helpers
-      class << self
-        def included(including_klass)
-          if including_klass.respond_to?(:after)  # rspec
+    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)
+          )
+
+          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
+    end
+
+    module RSpec
+      module Helpers
+        include Base::Helpers
+
+        class << self
+          def included(including_klass)
             including_klass.after do
               ProcessSettings.instance = initial_instance
             end
-          else                                    # minitest
+          end
+        end
+      end
+    end
+
+    module Minitest
+      module Helpers
+        include Base::Helpers
+
+        class << self
+          def included(including_klass)
             including_klass.define_method(:teardown) do
               ProcessSettings.instance = initial_instance
             end
           end
         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
-
-      def initial_instance
-        @initial_instance ||= ProcessSettings.instance
-      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.3.pre.1'
+  VERSION = '0.15.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.13.3.pre.1
+  version: 0.15.1
 platform: ruby
 authors:
 - Invoca
@@ -122,9 +122,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: