process_settings 0.10.6.pre.1 → 0.11.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f84a7b291c62e80a70aa63c5cd9fef3da8a479023b97b2b48876440e2ad3f78
-  data.tar.gz: ed14cf885d3c1e8f43aba4efd90b84aae91fba2e7d9aa0c044d3d87d60453ed0
+  metadata.gz: 59a90fdb765825b3e33cf5de6ceec5ffba64975aec6ec17062c18f53ca47e350
+  data.tar.gz: 30a111bd424743bbe3303fbd76651c160f2f2baae535dbcf1cc243be3339c6b5
 SHA512:
-  metadata.gz: db0012a991f04fe39c830010e5d5bb189ab0d4acd7211e04b3c606aa4267297b439ef42837238366a13798bef80a3ba078c192494b2d135b29b5ae80998e16ab
-  data.tar.gz: 571dd8f98045dd11f43dc4d349d0b3b0e094de80deb304a3a52905c6659e8643f6adf9cc31ae4474bdd55b8530d9698fcaaa940e1d4a21c84461686bdd32b8e0
+  metadata.gz: 9c185d646afc5c8ae430e2160f794b3dd29599ab711a5defdbcc0fa669ccac0b09baaa0a1fc0ad0b889400039b59f6c95cd3b5278fdb36c026aa8f74221ef79a
+  data.tar.gz: efe2370a36301f6e222037497ee8374d5997499de82dbb2d6a6da20150474598aab99d7cc0035a32cea494bf576ab4ceeaf026b97903dc8ffa782aa6e58923f3

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/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/version.rb

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

metadata

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