process_settings 0.11.0.pre.7 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be2ecaa41e362b6bbdfdb93a2ad08ec6e61bb444b43a757acc2062ce3e666fbc
-  data.tar.gz: 4cdecb04dbde4ba79bd0dd41ae4e2a37591b8aa1c1bc09a6d5b2c23f0d3ec409
+  metadata.gz: 73aea1798bdb8d5624c5f66dc1c2282a53b1c32fce2409983b35429a7a7432c7
+  data.tar.gz: c6e2d24b5e79ec87a94e6bda783a9f933ae1ab3282c5f9d8291f2f873cdd4840
 SHA512:
-  metadata.gz: 4e23f89dd2cdc890074d3fdb3eac84702a6e791ecfa61bb954fb1ed1addda947f0f21041ce2f485e0808ca6fb75a5d7137663b8777434b22c1596f2def0c2bb1
-  data.tar.gz: 74e411fae551d1a14fb39e7cd1a769b2515a9e25bdf72844ba1d3c1510abd833bf3ae6ecd047bd21112746e9836bfc9d6da60616bba644532c44bfe30de90a32
+  metadata.gz: e9ad1f070f4c9606ce7608c03d1db0345e290c945706883c04918b99910ab8985dec1505664844f5d2c15cfe6cbed9d7e77700a01d94096df0fb9204ad52555e
+  data.tar.gz: 3284db9c4250ac716e4c89cbdde718e5a1d079f97e99ca33925c6a1d537c6a50dd5beb5044af96f61cbd32bce8af6dabea8fdf193e71a480cbab818963ba2e59

data/README.md

@@ -126,16 +126,20 @@ The simplest approach--as shown above--is to read the latest settings at any tim
 http_version = ProcessSettings['frontend', 'http_version']
 ```
 
-#### Register an `on_change` Callback
-Alternatively, if you need to execute some code when there is a change, register a callback with `ProcessSettings.instance#on_change`:
+#### Register a `when_updated` Callback
+Alternatively, if you need to execute initially and whenever the value is updated, register a callback with `ProcessSettings.instance#when_updated`:
 ```
-ProcessSettings.instance.on_change do
+ProcessSettings.instance.when_updated do
   logger.level = ProcessSettings['frontend', 'log_level']
 end
 ```
-Note that all callbacks run sequentially on the shared change monitoring thread, so please be considerate!
+By default, the `when_updated` block is called initially when registered. We've found this to be convenient in most cases; it can be disabled by passing `initial_update: false`, in which case the block will be called 0 or more times in the future, when any of the process settings for this process change.
+
+`when_updated` is idempotent.
 
-There is no provision for unregistering callbacks. Instead, replace the `instance` of the monitor with a new one.
+In case you need to cancel the callback later, `when_updated` returns a handle (the block itself) which can later be passed into `cancel_when_updated`.
+
+Note that all callbacks run sequentially on the shared change monitoring thread, so please be considerate!
 
 ## Targeting
 Each settings YAML file has an optional `target` key at the top level, next to `settings`.

data/bin/combine_process_settings

@@ -10,6 +10,7 @@ require_relative '../lib/process_settings/targeted_settings'
 
 PROGRAM_NAME = File.basename($PROGRAM_NAME)
 SETTINGS_FOLDER = 'settings'
+MINIMUM_LIBYAML_VERSION = Gem::Version.new('0.2.6') # So that null (nil) values don't have trailing spaces.
 
 def end_marker(version)
   {
@@ -75,10 +76,29 @@ def add_warning_comment(yaml, root_folder, program_name, settings_folder)
   yaml.sub("\n", "\n" + warning_comment)
 end
 
+def check_libyaml_version
+  Gem::Version.new(Psych::LIBYAML_VERSION) >= MINIMUM_LIBYAML_VERSION or
+    warn <<~EOS
+
+      #{PROGRAM_NAME} error: libyaml version #{Psych::LIBYAML_VERSION} must be at least #{MINIMUM_LIBYAML_VERSION}. Try:
+  
+          brew update && upgrade libyaml
+  
+      You may also need:
+  
+          gem install psych -- --enable-bundled-libyaml
+    EOS
+
+  exit(1)
+end
+
+
 #
 # main
 #
 
+check_libyaml_version
+
 options = parse_options(ARGV.dup)
 
 combined_settings = read_and_combine_settings(Pathname.new(options.root_folder) + SETTINGS_FOLDER)

data/lib/process_settings/file_monitor.rb

@@ -29,8 +29,14 @@ module ProcessSettings
     end
     deprecate :start, deprecator: ActiveSupport::Deprecation.new('1.0', 'ProcessSettings') # will become private
 
-    def enable_listen_thread?(environment)
-      !disable_listen_thread?
+    def listen_thread_running?
+      !@listener.nil?
+    end
+
+    private
+
+    def enable_listen_thread?(environment = nil)
+      !disable_listen_thread?(environment)
     end
 
     def disable_listen_thread?(environment = nil)
@@ -40,14 +46,12 @@ module ProcessSettings
       when 'false', '0'
         false
       when nil
-        environment || service_env == 'test'
+        (environment || service_env) == 'test'
       else
         raise ArgumentError, "DISABLE_LISTEN_CHANGE_MONITORING has unknown value #{ENV['DISABLE_LISTEN_CHANGE_MONITORING'].inspect}"
       end
     end
 
-    private
-
     # optionally starts listening for changes, then loads current settings
     # Note: If with_listen_thread is truthy, this method creates a new thread that will be
     #       monitoring for changes.
@@ -82,6 +86,7 @@ module ProcessSettings
     # stops listening for changes
     def stop
       @listener&.stop
+      @listener = nil
     end
 
     def service_env

data/lib/process_settings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProcessSettings
-  VERSION = '0.11.0.pre.7'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.11.0.pre.7
+  version: 0.13.0
 platform: ruby
 authors:
 - Invoca
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-09-19 00:00:00.000000000 Z
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Targeted process settings that dynamically reload without restarting
   the process
 email: development+ps@invoca.com
@@ -97,7 +111,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/Invoca/process_settings
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,12 +122,12 @@ 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: 
+signing_key:
 specification_version: 4
 summary: Dynamic process settings
 test_files: []