config_skeleton 0.0.0.1.ENOTAG → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 001b8856fcc1b06142090ff8f3318a247b5bc810c438acb42db607a11b909151
-  data.tar.gz: 320df6546c31c1fc350385ef2d66eb0aecfa7c079e4895d1b545fecee5323ab0
+  metadata.gz: 6a58d74e2627a2f4f0ac79fa05c9ce07d2b17b8500af7e38d59fd7a33ac22fe7
+  data.tar.gz: 8b1d8531cc3fcc1183d14c465b886833b97130326d891b9da00ef05780b36a2c
 SHA512:
-  metadata.gz: ed0e93b5cdd4f0f4bd81396a6eeb6baef095c2eac0caa039e8dd013a55b764d155359baafcc6667d30a98c3df0f6fa3e1af457086fd72c0a18851ddd220ef8e4
-  data.tar.gz: d069e57a16755b4c6e78664c2bdf521b45a08152c7b7f78145b1f056c8ba8656ca9fce2b66c7970a0f9872812a4e6e70fc0676433ebc38e74fb2ecd6365c96a0
+  metadata.gz: 351a846e41802b033bb217d3a574a5a8a18633cc51845313d15ef41220c036a92d068a6959fde5eea4fb25b8586974baf6e02ea62369342d911de5023bcc0863
+  data.tar.gz: ebbf67d572a03b463b40e0e359446fd1e76d64ad4a0200556ffb78a425130aebf0876c23b0090e9770c9b6921a0e370d22d9e11520ad875b12b59d95671d4e2b

data/.github/workflows/ruby.yml

@@ -16,6 +16,7 @@ on:
   pull_request:
     branches:
       - master
+  workflow_dispatch:
 
 jobs:
   build:

data/.gitignore

@@ -4,5 +4,6 @@
 /.yardoc
 /coverage
 /.bundle
+/cfg.txt
 
 .rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

data/config_skeleton.gemspec

@@ -1,14 +1,7 @@
-begin
-  require 'git-version-bump'
-rescue LoadError
-  nil
-end
-
 Gem::Specification.new do |s|
   s.name = "config_skeleton"
 
-  s.version = GVB.version rescue "0.0.0.1.NOGVB"
-  s.date    = GVB.date    rescue Time.now.strftime("%Y-%m-%d")
+  s.version = "0.3.1"
 
   s.platform = Gem::Platform::RUBY
 
@@ -29,7 +22,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'github-release'
-  s.add_development_dependency 'git-version-bump'
   s.add_development_dependency 'rake', "~> 12.0"
   s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'rubocop'

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.
@@ -196,11 +197,12 @@ class ConfigSkeleton < ServiceSkeleton
 
     hook_signal(:HUP) do
       logger.info("SIGHUP") { "received SIGHUP, triggering config regeneration" }
-      regenerate_config(force_reload: true)
+      @trigger_regen_w << "."
     end
 
     initialize_config_skeleton_metrics
     @trigger_regen_r, @trigger_regen_w = IO.pipe
+    @terminate_r, @terminate_w = IO.pipe
   end
 
   # Expose the write pipe which can be written to to trigger a config
@@ -230,8 +232,6 @@ class ConfigSkeleton < ServiceSkeleton
 
     logger.debug(logloc) { "notifier fd is #{notifier.to_io.inspect}" }
 
-    @terminate_r, @terminate_w = IO.pipe
-
     loop do
       if ios = IO.select(
           [notifier.to_io, @terminate_r, @trigger_regen_r],
@@ -363,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
@@ -444,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}" }
@@ -467,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.0.0.1.ENOTAG
+  version: 0.3.1
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2020-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: git-version-bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -238,9 +224,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.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: