config_skeleton 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdaa156de0445e8a32b2d49d55ea11308d153d4c73658f6c4ff648a7c32a1440
-  data.tar.gz: 5dff0715f11dad930b6dd485204d9a1f2b75a47afc9096cb33dd0c4f5a538423
+  metadata.gz: 6a58d74e2627a2f4f0ac79fa05c9ce07d2b17b8500af7e38d59fd7a33ac22fe7
+  data.tar.gz: 8b1d8531cc3fcc1183d14c465b886833b97130326d891b9da00ef05780b36a2c
 SHA512:
-  metadata.gz: e5c7ffc7621e69441f17349d9e46a9d4f5146ed88a4c5b382524dfd64b7c0aa6b4aedc72bcb3ffac220509299983adff24263f86e8a327072ed34b933095ab3e
-  data.tar.gz: 50e06b7b3fbe40c4baf522b95595bd447ec3e349c2e14a1cbf7da64500f2db5a64d006ec6b9f15a2320fdbc76f879f733d91ff555c26d7eef7432d1fc46ff059
+  metadata.gz: 351a846e41802b033bb217d3a574a5a8a18633cc51845313d15ef41220c036a92d068a6959fde5eea4fb25b8586974baf6e02ea62369342d911de5023bcc0863
+  data.tar.gz: ebbf67d572a03b463b40e0e359446fd1e76d64ad4a0200556ffb78a425130aebf0876c23b0090e9770c9b6921a0e370d22d9e11520ad875b12b59d95671d4e2b

data/config_skeleton.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "config_skeleton"
 
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.platform = Gem::Platform::RUBY
 

data/lib/config_skeleton.rb

@@ -23,7 +23,8 @@ require 'tempfile'
 #
 # 1. Implement service-specific config generation and reloading code, by
 #    overriding the private methods #config_file, #config_data, and #reload_server
-#    (and also potentially #config_ok? and #sleep_duration).
+#    (and also potentially #config_ok?, #sleep_duration, #before_regenerate_config, and
+#    #after_regenerate_config).
 #    See the documentation for those methods for what they need to do.
 #
 # 1. Setup any file watchers you want with .watch and #watch.
@@ -362,6 +363,20 @@ class ConfigSkeleton < ServiceSkeleton
     raise NotImplementedError, "config_data must be implemented in subclass."
   end
 
+  # Run code before the config is regenerated and the config_file
+  # is written.
+  #
+  # @note this can optionally be implemented by subclasses.
+  #
+  def before_regenerate_config(force_reload); end
+
+  # Run code after the config is regenerated and if the regeneration
+  # was forced the new config has been cycled in.
+  #
+  # @note this can optionally be implemented by subclasses.
+  #
+  def after_regenerate_config(force_reload); end
+
   # Verify that the currently running config is acceptable.
   #
   # In the event that a generated config is "bad", it may be possible to detect
@@ -443,6 +458,8 @@ class ConfigSkeleton < ServiceSkeleton
   # @return [void]
   #
   def regenerate_config(force_reload: false)
+    before_regenerate_config(force_reload)
+
     logger.debug(logloc) { "force? #{force_reload.inspect}" }
     tmpfile = Tempfile.new(service_name, File.dirname(config_file))
     logger.debug(logloc) { "Tempfile is #{tmpfile.path}" }
@@ -466,6 +483,8 @@ class ConfigSkeleton < ServiceSkeleton
         cycle_config(tmpfile.path)
       end
     end
+
+    after_regenerate_config(force_reload)
   ensure
     metrics.last_change_timestamp.set({}, File.stat(config_file).mtime.to_f)
     tmpfile.close rescue nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_skeleton
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-26 00:00:00.000000000 Z
+date: 2020-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy