process_settings 0.11.0.pre.5 → 0.11.1.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ada8f710e24244a34005a22536e106cf086863b110d1908f58503df01797dedb
-  data.tar.gz: ae8fa6f78f2d4894a81f4e806b8408790520c38b0a19df723fe4a572eb3ffea4
+  metadata.gz: 074a7a2fc453de9cd6f46546ebe6040c61ebc2532df5bcfa07cb6841b70ef793
+  data.tar.gz: 01b1658b4a8d7cef95367cc91685c544417fac81633a736cbab87d791dda17ba
 SHA512:
-  metadata.gz: 5f58df6d01c42db7ec61b2c2815d3fdbe9cc8552e754edcad4e40a63816bbb6a621290acf2c0c636f87902e8fc10f28fc5330e4fd7250f8755e7d4c22f090304
-  data.tar.gz: 5a9ef3528655fbe57d3d23d9a2714fdc3223f9cc7234237cd20beb0f26891571f444d5a325bc2df1d9bfbff8e117b67ad769c797b2033c838c88064dc1bb567c
+  metadata.gz: 0025db7a10cc0157579a3bb3890b092626f613e01da5dd132e9017e634393b7fa15eb724070be939fe17e37816df08c43585dbdecf37f0437fd5b25261dc3874
+  data.tar.gz: c517c8d7e7d96f17e1fb1de6e0484793cbc9e9ae32add2238b48fae6b4619cb862e03ba7d3786490134acf1226f41db2b4bf204b4862010e51d5a1fc5c16e26f

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

@@ -13,7 +13,7 @@ module ProcessSettings
   class FileMonitor < AbstractMonitor
     attr_reader :file_path, :untargeted_settings
 
-    def initialize(file_path, logger:)
+    def initialize(file_path, logger:, environment: nil)
       super(logger: logger)
 
       @file_path = File.expand_path(file_path)
@@ -21,7 +21,7 @@ module ProcessSettings
       @untargeted_settings = nil
       @last_untargetted_settings = nil
 
-      start_internal(enable_listen_thread?)
+      start_internal(enable_listen_thread?(environment))
     end
 
     def start
@@ -29,8 +29,29 @@ module ProcessSettings
     end
     deprecate :start, deprecator: ActiveSupport::Deprecation.new('1.0', 'ProcessSettings') # will become private
 
+    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)
+      case ENV['DISABLE_LISTEN_CHANGE_MONITORING']
+      when 'true', '1'
+        true
+      when 'false', '0'
+        false
+      when nil
+        (environment || service_env) == 'test'
+      else
+        raise ArgumentError, "DISABLE_LISTEN_CHANGE_MONITORING has unknown value #{ENV['DISABLE_LISTEN_CHANGE_MONITORING'].inspect}"
+      end
+    end
+
     # 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.
@@ -65,29 +86,13 @@ module ProcessSettings
     # stops listening for changes
     def stop
       @listener&.stop
-    end
-
-    def enable_listen_thread?
-      !disable_listen_thread?
-    end
-
-    def disable_listen_thread?
-      case ENV['DISABLE_LISTEN_CHANGE_MONITORING']
-      when 'true', '1'
-        true
-      when 'false', '0'
-        false
-      when nil
-        service_env == 'test'
-      else
-        raise ArgumentError, "DISABLE_LISTEN_CHANGE_MONITORING has unknown value #{ENV['DISABLE_LISTEN_CHANGE_MONITORING'].inspect}"
-      end
+      @listener = nil
     end
 
     def service_env
-      if defined?(Rails) && Rails.respond_to(:env)
+      if defined?(Rails) && Rails.respond_to?(:env)
         Rails.env
-      end || ENV['SERVICE_ENV']
+      end || ENV['RAILS_ENV'] || ENV['SERVICE_ENV']
     end
 
     # Loads the most recent settings from disk

data/lib/process_settings/testing/helpers.rb

@@ -12,10 +12,10 @@ module ProcessSettings
       class << self
         def included(including_klass)
           after_method =
-            if including_klass.respond_to?(:teardown)
-              :teardown
-            else
+            if including_klass.respond_to?(:after)
               :after
+            else
+              :teardown
             end
 
           including_klass.send(after_method) do

data/lib/process_settings/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.11.0.pre.5
+  version: 0.11.1.pre.1
 platform: ruby
 authors:
 - Invoca