process_settings 0.10.5 → 0.11.0.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22513a938b872f9e3366d445d4c121aafd965c32bec9b937f9b2abe41ff73722
-  data.tar.gz: 4e352a2f5a80c19fd171810612b411762372aec422464f684cbcfe71d5d27602
+  metadata.gz: 00cb781d3385028324b7dd6f55e12da7550901107adf78ee57abde78987335b4
+  data.tar.gz: b8ae66252379583f2ac9a8da599e54d559fbd92d4d40b12d36faa6539114e511
 SHA512:
-  metadata.gz: ac2cf3d580dd5c27c4bed2a10a59024d886bcfecd2cae4a2b39ddc3e34b78a82f41e01323bc0732144c4bd2823c1e379c2bd218ebf34cf4dc2b1a992d9bf9b20
-  data.tar.gz: 97b556d773340f019947a3c623faea53086274a8ff03b62b61583c757e3d7228acb0d1b800ad21076831648238dcca008f7a0cf939ade944d33fc3832b78828d
+  metadata.gz: c0229a56f9a6e8f6fe20fa0b19cdb82f2df4d82dbd3abd0c7d74cd0b136200e7ac48a261252b60fcd467f6b0c8a8967e8b62e6237f8cf737d871edbc8c0db189
+  data.tar.gz: 528650ea37e3fa716b588d76d5cef31af6e06e6d5fd506b4f7b65f13d51e38fd45a3f65a3c004cff0e294df47ec9397c29870dd26cdba0ea05ec5b80ef21bb3e

data/README.md

@@ -21,25 +21,25 @@ gem 'process_settings', '~> 0.4'
 ```
 
 ## Usage
-The `ProcessSettings::Monitor` and related classes can be freely created and used at any time.
-But typical usage is through the `ProcessSettings::Monitor.instance`.
+The `ProcessSettings::FileMonitor` and related classes can be freely created and used at any time.
+But typical usage is through the `ProcessSettings.instance`.
 That should be configured at process startup before use.
 ### Configuration
-Before using `ProcessSettings::Monitor.instance`, you must first configure the path to the combined process settings file on disk,
+Before using `ProcessSettings.instance`, you must first configure the path to the combined process settings file on disk,
 and provide a logger.
 ```ruby
 require 'process_settings'
 
-ProcessSettings::Monitor.file_path = "/etc/process_settings/combined_process_settings.yml"
-ProcessSettings::Monitor.logger = logger
+ProcessSettings.instance = ProcessSettings::FileMonitor.new("/etc/process_settings/combined_process_settings.yml",
+                                                            logger: logger)
 ```
-### Monitor Initialization
-The `ProcessSettings::Monitor` is a hybrid singleton. The class attribute `instance` returns
-the current instance. If not already set, this is lazy-created based on the above configuration.
+### Instance Initialization
+The `ProcessSettings` is a hybrid singleton. The class attribute `instance` returns
+the current instance as set at configuration time. Deprecated: If not already set, this is lazy-created based on the above configuration.
 
 The monitor should be initialized with static (unchanging) context for your process:
 ```
-ProcessSettings::Monitor.static_context = {
+ProcessSettings.instance.static_context = {
   "service_name" => "frontend",
   "datacenter" => "AWS-US-EAST-1"
 }
@@ -76,7 +76,7 @@ log_level = ProcessSettings['frontend', 'log_level']
 => "info"
 ```
 #### ProcessSettings[] interface
-The `ProcessSettings[]` method delegates to `ProcessSettings::Monitor#[]` on the `instance`.
+The `ProcessSettings[]` method delegates to `ProcessSettings.instance#[]` on the `instance`.
 
 `[]` interface:
 
@@ -114,22 +114,22 @@ http_version = ProcessSettings['frontend', 'http_version', required: false] || 2
 
 ### Dynamic Settings
 
-The `ProcessSettings::Monitor` loads settings changes dynamically whenever the file changes,
+The `ProcessSettings::FileMonitor` loads settings changes dynamically whenever the file changes,
 by using the [listen](https://github.com/guard/listen) gem which in turn uses the `INotify` module of the Linux kernel, or `FSEvents` on MacOS. There is no need to restart the process or send it a signal to tell it to reload changes.
 
 There are two ways to get access the latest settings from inside the process:
 
 #### Read Latest Setting Through `ProcessSettings[]`
 
-The simplest approach--as shown above--is to read the latest settings at any time through `ProcessSettings[]` (which delegates to `ProcessSettings::Monitor.instance`):
+The simplest approach--as shown above--is to read the latest settings at any time through `ProcessSettings[]` (which delegates to `ProcessSettings.instance`):
 ```
 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::Monitor#on_change`:
+Alternatively, if you need to execute some code when there is a change, register a callback with `ProcessSettings.instance#on_change`:
 ```
-ProcessSettings::Monitor.instance.on_change do
+ProcessSettings.instance.on_change do
   logger.level = ProcessSettings['frontend', 'log_level']
 end
 ```
@@ -166,7 +166,7 @@ The settings YAML files are always combined in alphabetical order by file path.
 ### Testing
 For testing, it is often necessary to set a specific override hash for the process_settings values to use in
 that use case.  The `ProcessSettings::Testing::Helpers` module is provided for this purpose.  It can be used to
-override a specific hash of process settings, while leving the rest in tact, and resetting back to the defaults
+override a specific hash of process settings, while leaving the rest intact, and resetting back to the defaults
 after the test case is over.  Here are some examples using various testing frameworks:
 
 #### RSpec
@@ -179,10 +179,7 @@ RSpec.configure do |config|
 
   include ProcessSettings::Testing::Helpers
 
-  after do
-   reset_process_settings
-  end
-
+  # Note: the include above will automatically register a global after block that will reset process_settings to their initial values.
   # ...
 end
 ```
@@ -205,14 +202,14 @@ end
 require 'process_settings/testing/helpers'
 
 context SomeClass do
+  include ProcessSettings::Testing::Helpers
+
+  # Note: the include above will automatically register a teardown block that will reset process_settings to their initial values.
+
   setup do
     stub_process_settings(honeypot: { answer_odds: 100 })
   end
 
-  teardown do
-    reset_process_settings
-  end
-
   # ...
 end
 ```

data/lib/process_settings/abstract_monitor.rb

@@ -15,7 +15,7 @@ module ProcessSettings
     attr_reader :static_context, :statically_targeted_settings
 
     def initialize(logger:)
-      @logger = logger
+      @logger = logger or raise ArgumentError, "logger must be not be nil"
       @on_change_callbacks = []
       @when_updated_blocks = Set.new
       @static_context = {}

data/lib/process_settings/file_monitor.rb

@@ -45,7 +45,7 @@ module ProcessSettings
         end
       end
 
-      unless ENV['DISABLE_LISTEN_CHANGE_MONITORING']
+      if enable_listen_thread?
         @listener.start
       end
 
@@ -58,8 +58,29 @@ module ProcessSettings
       @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
+    end
+
     private
 
+    def service_env
+      (defined?(Rails) && Rails.env) || ENV['SERVICE_ENV']
+    end
+
     # Loads the most recent settings from disk
     def load_untargeted_settings
       new_untargeted_settings = load_file(file_path)

data/lib/process_settings/monitor.rb

@@ -13,7 +13,6 @@ module ProcessSettings
       attr_writer :instance
 
       def file_path=(new_file_path)
-        ActiveSupport::Deprecation.warn("ProcessSettings::Monitor.file_path= is deprecated and will be removed in v1.0.")
         clear_instance
 
         @file_path = new_file_path
@@ -31,11 +30,16 @@ module ProcessSettings
       end
 
       def instance
-        @instance ||= default_instance
+        if @instance
+          @instance
+        else
+          ActiveSupport::Deprecation.warn("`ProcessSettings::Monitor.instance` lazy create is deprecated and will be removed in v1.0. Assign a `FileMonitor` object to `ProcessSettings.instance =` instead.")
+          @instance = default_instance
+        end
       end
 
       def default_instance
-        ActiveSupport::Deprecation.warn("`ProcessSettings::Monitor.instance` is deprecated and will be removed in v1.0. Assign a `FileMonitor` object to `ProcessSettings.instance` instead.")
+        ActiveSupport::Deprecation.warn("`ProcessSettings::Monitor.instance` is deprecated and will be removed in v1.0. Assign a `FileMonitor` object to `ProcessSettings.instance =` instead.")
         @default_instance ||= new_from_settings
       end
 

data/lib/process_settings/target.rb

@@ -98,7 +98,7 @@ module ProcessSettings
 
     class << self
       def true_target
-        @true_target || new(TRUE_JSON_DOC)
+        @true_target ||= new(TRUE_JSON_DOC)
       end
     end
   end

data/lib/process_settings/testing/helpers.rb

@@ -9,7 +9,20 @@ require 'process_settings/testing/monitor'
 module ProcessSettings
   module Testing
     module Helpers
-
+      class << self
+        def included(including_klass)
+          after_method =
+            if including_klass.respond_to?(:teardown)
+              :teardown
+            else
+              :after
+            end
+
+          including_klass.send(after_method) do
+            ProcessSettings.instance = initial_instance
+          end
+        end
+      end
       # Adds the given settings_hash as an override at the end of the process_settings array, with default targeting (true).
       # Therefore this will override these settings while leaving others alone.
       #
@@ -34,8 +47,6 @@ module ProcessSettings
         )
       end
 
-      private
-
       def initial_instance
         @initial_instance ||= ProcessSettings.instance
       end

data/lib/process_settings/testing/monitor_stub.rb

@@ -11,8 +11,14 @@ module ProcessSettings
   module Testing
     # This class implements the Monitor#targeted_value interface but is stubbed to use a simple hash in tests
     class MonitorStub
+      class << self
+        def new(*_args)
+          ActiveSupport::Deprecation.warn("ProcessSettings::Testing::MonitorStub is deprecated and will be removed in future versions. Use ProcessSettings::Testing::Monitor instead.", caller)
+          super
+        end
+      end
+
       def initialize(settings_hash)
-        ActiveSupport::Deprecation.warn("ProcessSettings::Testing::MonitorStub is deprecated and will be removed in future versions. Use ProcessSettings::Testing::Monitor instead.", caller)
         @settings_hash = HashWithHashPath[settings_hash]
       end
 

data/lib/process_settings/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.10.5
+  version: 0.11.0.pre.4
 platform: ruby
 authors:
 - Invoca
@@ -108,9 +108,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: