process_settings 0.4.0.pre.2 → 0.4.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c32d23d7503792ad86bb246e9d6363549a8f2810
-  data.tar.gz: 55f3900720da5e83839220d36ea1d2528e44b8c1
+  metadata.gz: 35f7f59386045aa27ee3134236eed4d9681090b3
+  data.tar.gz: b9fa6bdfffe65b11b6858b9826a09dfc8de990bd
 SHA512:
-  metadata.gz: c5f38b5e5cd23422e7aa93d5200330d0ffd8d0b0f4bca65195d7c9933a70fa25ef93c86bf8e18f31850463c750074be6e0a37d24f9445898b5f0d4da6e82c0aa
-  data.tar.gz: 645b3393990436b24173375813347f5cf8af7abcb7c57ee2fbc1c0a5109ea7bd7103fb6495016f979ddc6ed34cc6ee3929c9a8f326b133caa7c68f9c85324869
+  metadata.gz: 173134db7642f5e1622b6c640c12b7c4ef3024bc328bf215fe3cc613b71d47651e068c73504f83af546d2c9cd09085d73d8f3878e86e48a3ec215ac3fa8e50ee
+  data.tar.gz: 6c910bd0d0372e2c0e41dcd274732dbb3a60e0ac8ad1e9e2998a495c9a438c321c6fc6fba136911ff01416d3e5a6ffbb5db8e71fe091c2800665fcd6d1e6a811

data/lib/process_settings/monitor.rb

@@ -8,7 +8,7 @@ require 'active_support'
 
 module ProcessSettings
   class Monitor
-    attr_reader :file_path, :min_polling_seconds
+    attr_reader :file_path, :min_polling_seconds, :logger
     attr_reader :static_context, :untargeted_settings, :statically_targeted_settings
 
     DEFAULT_MIN_POLLING_SECONDS = 5
@@ -30,6 +30,8 @@ module ProcessSettings
         if modified.include?(@file_path)
           @logger.info("ProcessSettings::Monitor file #{@file_path} changed. Reloading.")
           load_untargeted_settings
+
+          load_statically_targeted_settings
         end
       end
 
@@ -37,7 +39,7 @@ module ProcessSettings
 
       load_untargeted_settings
 
-      statically_targeted_settings # so that notify_on_change will be called if any changes
+      load_statically_targeted_settings
     end
 
     # stops listening for changes
@@ -51,30 +53,11 @@ module ProcessSettings
       @on_change_callbacks << callback
     end
 
-    # Loads the most recent settings from disk and returns them.
-    def load_untargeted_settings
-      @untargeted_settings = load_file(file_path)
-    end
-
     # Assigns a new static context. Recomputes statically_targeted_settings.
     def static_context=(context)
       @static_context = context
 
-      statically_targeted_settings(force: true)
-    end
-
-    # 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.
-    def statically_targeted_settings(force: false)
-      if force || @last_untargetted_settings != @untargeted_settings
-        @statically_targeted_settings = @untargeted_settings.with_static_context(@static_context)
-        @last_untargetted_settings = @untargeted_settings
-
-        notify_on_change
-      end
-
-      @statically_targeted_settings
+      load_statically_targeted_settings(force_retarget: true)
     end
 
     # Returns the process settings value at the given `path` using the given `dynamic_context`.
@@ -97,6 +80,32 @@ module ProcessSettings
       end
     end
 
+    private
+
+    # Loads the most recent settings from disk
+    def load_untargeted_settings
+      new_untargeted_settings = load_file(file_path)
+      old_version = @untargeted_settings&.version
+      new_version = new_untargeted_settings.version
+      @untargeted_settings = new_untargeted_settings
+      logger.info("ProcessSettings::Monitor#load_untargeted_settings loaded version #{new_version}#{" to replace version #{old_version}" if old_version}")
+    end
+
+    # 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.
+    def load_statically_targeted_settings(force_retarget: false)
+      if force_retarget || @last_untargetted_settings != @untargeted_settings
+        @last_untargetted_settings = @untargeted_settings
+        @statically_targeted_settings = @untargeted_settings.with_static_context(@static_context)
+        if @last_statically_targetted_settings != @statically_targeted_settings
+          @last_statically_targetted_settings = @statically_targeted_settings
+
+          notify_on_change
+        end
+      end
+    end
+
     class << self
       attr_accessor :file_path
       attr_reader :logger
@@ -117,8 +126,9 @@ module ProcessSettings
       end
     end
 
-    private
-
+    # Calls all registered on_change callbacks. Rescues any exceptions they may raise.
+    # Note: this method can be re-entrant to the class; the on_change callbacks may call right back into these methods.
+    # Therefore it's critical to finish all transitions and release any resources before calling this method.
     def notify_on_change
       @on_change_callbacks.each do |callback|
         begin

data/lib/process_settings/replace_versioned_file.rb

@@ -5,31 +5,52 @@ require_relative 'targeted_settings'
 module ProcessSettings
   # This class will override a file with a higher version file; it accounts for minor version number use
   module ReplaceVersionedFile
+    class SourceVersionOlderError < StandardError; end
+    class FileDoesNotExistError < StandardError; end
+
     class << self
+      # Contracts
+      #   source_file_path must be present
+      #   destination_file_path must be present
+      #   source_file_path must exist on filesystem
+      #   source file version cannot be older destination version
       def replace_file_on_newer_file_version(source_file_path, destination_file_path)
         source_file_path.to_s      == '' and raise ArgumentError, "source_file_path not present"
         destination_file_path.to_s == '' and raise ArgumentError, "destination_file_path not present"
+        File.exist?(source_file_path) or raise FileDoesNotExistError, "source file '#{source_file_path}' does not exist"
+        validate_source_version_is_not_older(source_file_path, destination_file_path)
 
         if source_version_is_newer?(source_file_path, destination_file_path)
           FileUtils.mv(source_file_path, destination_file_path)
         elsif source_file_path != destination_file_path # make sure we're not deleting destination file
-          if File.exist?(source_file_path)
-            FileUtils.remove_file(source_file_path) # clean up, remove left over file
-          end
+          FileUtils.rm_f(source_file_path) # clean up, remove left over file
         end
       end
 
       private
 
       def source_version_is_newer?(source_file_path, destination_file_path)
-        if File.exist?(source_file_path)
-          if File.exist?(destination_file_path)
-            source_version      = ProcessSettings::TargetedSettings.from_file(source_file_path, only_meta: true).version
-            destination_version = ProcessSettings::TargetedSettings.from_file(destination_file_path, only_meta: true).version
-
-            Gem::Version.new(source_version) > Gem::Version.new(destination_version)
-          else
-            true
+        if File.exist?(destination_file_path)
+          source_version      = ProcessSettings::TargetedSettings.from_file(source_file_path, only_meta: true).version
+          destination_version = ProcessSettings::TargetedSettings.from_file(destination_file_path, only_meta: true).version
+
+          source_version.to_f > destination_version.to_f
+        else
+          true
+        end
+      end
+
+      def validate_source_version_is_not_older(source_file_path, destination_file_path)
+        if File.exist?(destination_file_path)
+          source_version      = ProcessSettings::TargetedSettings.from_file(source_file_path, only_meta: true).version
+          destination_version = ProcessSettings::TargetedSettings.from_file(destination_file_path, only_meta: true).version
+
+          if source_version.to_f < destination_version.to_f
+            FileUtils.rm_f(source_file_path) # clean up, remove left over file
+
+            raise SourceVersionOlderError,
+                  "source file '#{source_file_path}' is version #{source_version}"\
+                  " and destination file '#{destination_file_path}' is version #{destination_version}"
           end
         end
       end

data/lib/process_settings/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
 module ProcessSettings
-  VERSION = '0.4.0.pre.2'
+  VERSION = '0.4.0.pre.3'
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre.2
+  version: 0.4.0.pre.3
 platform: ruby
 authors:
 - Invoca