process_settings 0.11.0 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 325c0d9bcbdf24e24b98ff61ceb8f66c7a86eedf659703fa1696a9969fc20399
-  data.tar.gz: fcd0872ad94d1b6946fd577bbe3aaff376febf449f282f149b4cbb40f00cfaaa
+  metadata.gz: 3825ac379576930a892de053c60a8a5ea108cf18ca231c36afb74d29e023e873
+  data.tar.gz: 9e06cf4895b856fa801f868a5e600023ab27cbbee2a730f8d2c776de6b14ea62
 SHA512:
-  metadata.gz: 9b114a06259666f47cb8f052354655ac0ece1f29dafd1ddf4939eb5c197e97aafca65af0c4c3a8ee383d2d739caef0769226d38365f48687410a001f1054bae4
-  data.tar.gz: f09a461c8826e55797c67c6222084510933ba30d4c2696c82ff4193a0d22bf1c011a1112a703c2bf3582e68af6e258f6ee93adee2d505a71981c7715c0f59970
+  metadata.gz: 38a7e49c5782b72c334f9029388ffb06aa94cf3fd7dffc73a7750f102445c21fb8788df60d37af53e68f1e58956ef429cd7a3a442e117095eea74bd89bc2340d
+  data.tar.gz: ac57357cd9873b9a8f42b98046b5ebd942e9058083d0b71711879ea73c917671967ffbc34aa3be77dc3b8b844d6f966a3b13c88860ccc2a7e8a659f1eecad117

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

@@ -75,12 +75,34 @@ def add_warning_comment(yaml, root_folder, program_name, settings_folder)
   yaml.sub("\n", "\n" + warning_comment)
 end
 
+MINIMUM_LIBYAML_VERSION = '0.2.5' # So that null (nil) values don't have trailing spaces.
+
+def check_libyaml_version
+  if Gem::Version.new(Psych::LIBYAML_VERSION) < Gem::Version.new(MINIMUM_LIBYAML_VERSION)
+    warn <<~EOS
+
+      #{PROGRAM_NAME} error: libyaml version #{Psych::LIBYAML_VERSION} must be at least #{MINIMUM_LIBYAML_VERSION}. Try:
+
+          brew update && brew upgrade libyaml
+
+      You may also need:
+
+          gem install psych -- --enable-bundled-libyaml
+    EOS
+
+    exit(1)
+  end
+end
+
+
 #
 # main
 #
 
 options = parse_options(ARGV.dup)
 
+check_libyaml_version
+
 combined_settings = read_and_combine_settings(Pathname.new(options.root_folder) + SETTINGS_FOLDER)
 
 version_number = options.version || default_version_number(options.initial_filename)

data/lib/process_settings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProcessSettings
-  VERSION = '0.11.0'
+  VERSION = '0.13.2'
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.2
 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
@@ -113,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Dynamic process settings
 test_files: []