process_settings 0.11.0.pre.8 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48d483b1a29cf0442c77c1d5b1e95c13d25167e7314d903dc7389db16baebc5e
-  data.tar.gz: e7b5463577055a1471af3d48f84e7968db665a565a9022beddf309c56407f6cc
+  metadata.gz: 60447e2f039f0d12d6f35a21b8b823c9f9dea2294900c0d3310ccf40dfe0a3e1
+  data.tar.gz: dceadf48d13853e709d5b35bfd5740551cc3baabd4df07e0d3b64c855f5caba7
 SHA512:
-  metadata.gz: 1097d637758fe0eef6db447496056c14d4e5854a0d3a632f9d203e915996ce4e4cdf35afd59f06e084d8f875896199c6d765b1feb6d92c003af5c6a1e34a8c22
-  data.tar.gz: b497681fef4ebd4fc41ee7c63bb821966f72136f0d11ba34e87f4bd4475fdc9e190ac45e1fe0372cac05f1a70e6625e9ac482bfe837990fbf2265be82ea10465
+  metadata.gz: d33df4bfb607626f41f8c0059b821caab6b6f50a900aef9a6aefd5f6e47c562e44d5c32f75b99412e22c7375c74dbf39c37c4e0812896f1ac84363b2b01bfe84
+  data.tar.gz: 18a90e814c09e2666da73970998a8eda9bca90fe216ef7bf4c7d2b463cafb77b42a2ba07e478eaaca186f422a43b4a4859c2ea7ba56a647a6ff66621fb1fefd1

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 && 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/file_monitor.rb

@@ -33,6 +33,8 @@ module ProcessSettings
       !@listener.nil?
     end
 
+    private
+
     def enable_listen_thread?(environment = nil)
       !disable_listen_thread?(environment)
     end
@@ -44,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.

data/lib/process_settings/version.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.11.0.pre.8
+  version: 0.13.1
 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: []