process_settings 0.6.0 → 0.7.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dbcb3873001cffeeb4e0ae854bde7a30ef65f5ab84f1abce46d823387522aef
-  data.tar.gz: 62cf394daea0cea79d71d8b775cdefbdc056aaf40e53103a90ac0482050f66b7
+  metadata.gz: f2b30454f2b5c672186e76fa87b45aa330d62fd3c09e96366c4377f4b397ea36
+  data.tar.gz: 5bae6a21f59d81f3f365857e5e95fe4cc95b9b047825cd734d5541326ede4a25
 SHA512:
-  metadata.gz: aecb307bcd9f2730d59cd56fa0001fd3515c7f4d299a70fa41aac980b2beaa67a6a2f1006bfbd2df434d613dddc06102fd10c2d11f0d62cf1bb42911925ead92
-  data.tar.gz: 5cc5ea088913ced0a55f66d1e54e5783c38d1199f5eef3be291d547bc1a472151ec0055fc5ad7763908e2febb506f96d4d0f2f4e014a7e52f68f5ea6589e8605
+  metadata.gz: 9f928a7ba0fdf1d1050445c363b67ef95b7c3d0c1a2e2a7f79cbf7cf32b06c9aa18172952b7f2e5c364b4f0cedbd2aeb3795466499b141a27a0ebe57e4627979
+  data.tar.gz: 26c3b75186e76c80e90e380c6da0433822999acffadb702a5d36b71f284aac27da099a952f596543c4728953036e9742bd6ba70629851fa4098e1d46d14c475e

data/lib/process_settings/monitor.rb

@@ -9,6 +9,8 @@ require 'active_support'
 module ProcessSettings
   class SettingsPathNotFound < StandardError; end
 
+  OnChangeDeprecation = ActiveSupport::Deprecation.new('1.0', 'ProcessSettings::Monitor')
+
   class Monitor
     attr_reader :file_path, :min_polling_seconds, :logger
     attr_reader :static_context, :untargeted_settings, :statically_targeted_settings
@@ -19,6 +21,7 @@ module ProcessSettings
       @file_path = File.expand_path(file_path)
       @logger = logger
       @on_change_callbacks = []
+      @when_updated_blocks = Set.new
       @static_context = {}
       @last_statically_targetted_settings = nil
       @untargeted_settings = nil
@@ -63,15 +66,35 @@ module ProcessSettings
       @listener&.stop
     end
 
-    # TODO:
-    # 1. rename this to `when_updated` and clone that interface from InvocaCluster
-    # 2. since the callback yields self, support Instance#[]; have ProcessSettings.[] delegate there.
+    # Idempotently adds the given block to the when_updated collection
+    # calls the block first unless initial_update: false is passed
+    # returns a handle (the block itself) which can later be passed into cancel_when_updated
+    def when_updated(initial_update: true, &block)
+      if @when_updated_blocks.add?(block)
+        if initial_update
+          begin
+            block.call(self)
+          rescue => ex
+            logger.error("ProcessSettings::Monitor#when_updated rescued exception during initialization:\n#{ex.class}: #{ex.message}")
+          end
+        end
+      end
+
+      block
+    end
+
+    # removes the given when_updated block identified by the handle returned from when_updated
+    def cancel_when_updated(handle)
+      @when_updated_blocks.delete_if { |callback| callback.eql?(handle) }
+    end
 
     # Registers the given callback block to be called when settings change.
     # These are run using the shared thread that monitors for changes so be courteous and don't monopolize it!
+    # @deprecated
     def on_change(&callback)
       @on_change_callbacks << callback
     end
+    deprecate on_change: :when_updated, deprecator: OnChangeDeprecation
 
     # Assigns a new static context. Recomputes statically_targeted_settings.
     # Keys must be strings or integers. No symbols.
@@ -128,7 +151,7 @@ module ProcessSettings
 
     # Loads the latest untargeted settings from disk. Returns the current process settings as a TargetAndProcessSettings given
     # by applying the static context to the current untargeted settings from disk.
-    # If these have changed, borrows this thread to call notify_on_change.
+    # If these have changed, borrows this thread to call notify_on_change and call_when_updated_blocks.
     def load_statically_targeted_settings(force_retarget: false)
       if force_retarget || @last_untargetted_settings != @untargeted_settings
         @last_untargetted_settings = @untargeted_settings
@@ -137,6 +160,7 @@ module ProcessSettings
           @last_statically_targetted_settings = @statically_targeted_settings
 
           notify_on_change
+          call_when_updated_blocks
         end
       end
     end
@@ -151,9 +175,11 @@ module ProcessSettings
       end
 
       def instance
-        file_path or raise ArgumentError, "#{self}::file_path must be set before calling instance method"
-        logger or raise ArgumentError, "#{self}::logger must be set before calling instance method"
-        @instance ||= new(file_path, logger: logger)
+        @instance ||= begin
+                        file_path or raise ArgumentError, "#{self}::file_path must be set before calling instance method"
+                        logger or raise ArgumentError, "#{self}::logger must be set before calling instance method"
+                        new(file_path, logger: logger)
+                      end
       end
 
       def logger=(new_logger)
@@ -189,6 +215,14 @@ module ProcessSettings
       end
     end
 
+    def call_when_updated_blocks
+      @when_updated_blocks.each do |block|
+        block.call(self)
+      rescue => ex
+        logger.error("ProcessSettings::Monitor#call_when_updated_blocks rescued exception:\n#{ex.class}: #{ex.message}")
+      end
+    end
+
     def load_file(file_path)
       TargetedSettings.from_file(file_path)
     end

data/lib/process_settings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProcessSettings
-  VERSION = '0.6.0'
+  VERSION = '0.7.0.pre.1'
 end

metadata

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