process_settings 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9c510ffc0718c9a0cc8db0052d7abe3a9d08669567b7ddfee82a3f8666ed9f3
-  data.tar.gz: 535c278059881ae7cfbbe671266e42cb2f7b5d78d16f369caad13096ca0db03d
+  metadata.gz: d346028f0e5292862f740f24b653940c321d802eeb52cec982dd5b8db2a3152e
+  data.tar.gz: 9eb2b3d22bedacf239a777ee23606badf82c664d2b69cc28067bd47aaef6e90f
 SHA512:
-  metadata.gz: 8635354029bce4a6dfa49d00c21e20eb17dd095dbe16b32aaaf1b249323d28ffbeb0f8adbd9cbc2a060ff046d92a19b77a8708d8df5bcc7704e45352135cffa8
-  data.tar.gz: 405d6a5d9e155b196e7ac1beed18493cb00630be74919db79ef2005ef0e201ae9a9c01991b58b07b00ce9a5d01cfc489aad80dfceabe556b8e3245685bfd02d6
+  metadata.gz: 38e4b19aa83dd76fd8ba875bc8aad8c96e924e8dc44eaf080f7dcb42cb20c8c761fe31b9e691d5547df8c3eb9ba1111696e6bf04251cbd2462681f685ea77574
+  data.tar.gz: 69fe761830b9ae703a6a976590d641b289b26fa95add7e1b6258ad72736f528aa871f2c77de3f3119f9a143adb0b3f45df5c9b4dba6af4b05820dd29abc7212f

data/README.md

@@ -3,7 +3,7 @@ This gem provides dynamic settings for Ruby processes. The settings are stored i
 Settings are managed in a git repo, in separate YAML files for each concern (for example, each micro-service). Each YAML file can be targeted based on matching context values (for example, `service_name`).
 
 
-The context can be either static to the process (for example, `service_name` or `data_center`) or dynamic (for example, the current web request `domain`).
+The context can be either static to the process (for example, `service_name` or `datacenter`) or dynamic (for example, the current web request `domain`).
 
 ## Installation
 To install this gem directly on your machine from rubygems, run the following:
@@ -37,7 +37,7 @@ The monitor should be initialized with static (unchanging) context for your proc
 ```
 ProcessSettings::Monitor.static_context = {
   "service_name" => "frontend",
-  "data_center" => "AWS-US-EAST-1"
+  "datacenter" => "AWS-US-EAST-1"
 }
 ```
 The `static_context` is important because it is used to pre-filter settings for the process.
@@ -143,22 +143,38 @@ To `target` on context values, provide a hash of key-value pairs. All keys must
 ```
 target:
   service_name: frontend
-  data_center: AWS-US-EAST-1
+  datacenter: AWS-US-EAST-1
 ```
-This will be applied in any process that has `service_name == "frontend"` AND is running in `data_center == "AWS-US-EAST-1"`.
+This will be applied in any process that has `service_name == "frontend"` AND is running in `datacenter == "AWS-US-EAST-1"`.
 
 ### Multiple Values Are OR'd
 Values may be set to an array, in which case the key matches if _any_ of the values matches. For example, consider this target hash:
 ```
 target:
   service_name: [frontend, auth]
-  data_center: AWS-US-EAST-1
+  datacenter: AWS-US-EAST-1
 ```
-This will be applied in any process that has (`service_name == "frontend"` OR `service_name == "auth"`) AND `data_center == "AWS-US-EAST-1"`.
+This will be applied in any process that has (`service_name == "frontend"` OR `service_name == "auth"`) AND `datacenter == "AWS-US-EAST-1"`.
 
 ### Precedence
 The settings YAML files are always combined in alphabetical order by file path. Later settings take precedence over the earlier ones.
 
+### Testing
+For testing, it is often necessary to set a specific hash for the process_settings values to use in that test case.
+The `ProcessSettings::Testing::MonitorStub` class is provided for this purpose. It can be initialized with a hash and assigned to `ProcessSettings::Monitor.instance`. After the test runs, make sure to call `clear_instance`.
+Note that it has no `targeting` or `settings` keys; it is stubbing the resulting settings hash _after_ targeting has been applied.
+Here is an example using `rspec` conventions:
+```
+before do
+  settings = { "honeypot" => { "answer_odds" => 100 } }
+  ProcessSettings::Monitor.instance = ProcessSettings::Testing::MonitorStub.new(settings)
+end
+
+after do
+  ProcessSettings::Monitor.clear_instance
+end
+```
+
 ## Contributions
 
 Contributions to this project are always welcome.  Please thoroughly read our [Contribution Guidelines](https://github.com/Invoca/process_settings/blob/master/CONTRIBUTING.md) before starting any work.

data/bin/process_settings_for_services

@@ -62,14 +62,14 @@ flat_services_yml_json_doc.each do |service, nodes|
       if (changed = node_targeted_process_settings_old != node_targeted_process_settings_new)
         node_old =  node_targeted_process_settings_old.map do |node_targeted_process_setting|
                       {
-                        'target'            => node_targeted_process_setting.target,
-                        "process_settings"  => node_targeted_process_setting.process_settings
+                        'target'    => node_targeted_process_setting.target,
+                        "settings"  => node_targeted_process_setting.settings
                       }
                     end
         node_new =  node_targeted_process_settings_new.map do |node_targeted_process_setting|
                       {
-                        'target'            => node_targeted_process_setting.target,
-                        "process_settings"  => node_targeted_process_setting.process_settings
+                        'target'    => node_targeted_process_setting.target,
+                        "settings"  => node_targeted_process_setting.settings
                       }
                     end
 

data/lib/process_settings/monitor.rb

@@ -81,7 +81,7 @@ module ProcessSettings
       result = statically_targeted_settings.reduce(:not_found) do |latest_result, target_and_settings|
         # find last value from matching targets
         if target_and_settings.target.target_key_matches?(full_context)
-          if (value = target_and_settings.process_settings.json_doc.mine(*path, not_found_value: :not_found)) != :not_found
+          if (value = target_and_settings.settings.json_doc.mine(*path, not_found_value: :not_found)) != :not_found
             latest_result = value
           end
         end

data/lib/process_settings/target_and_settings.rb

@@ -6,7 +6,7 @@ require_relative 'settings'
 module ProcessSettings
   # This class encapsulates a single YAML file with target and process_settings.
   class TargetAndSettings
-    attr_reader :filename, :target, :process_settings
+    attr_reader :filename, :target, :settings
 
     def initialize(filename, target, settings)
       @filename = filename
@@ -15,7 +15,7 @@ module ProcessSettings
       @target = target
 
       settings.is_a?(Settings) or raise ArgumentError, "settings must be a ProcessSettings; got #{settings.inspect}"
-      @process_settings = settings
+      @settings = settings
     end
 
     def ==(rhs)
@@ -29,7 +29,7 @@ module ProcessSettings
     def to_json_doc
       {
         "target" => @target.json_doc,
-        "settings" => @process_settings.json_doc
+        "settings" => @settings.json_doc
       }
     end
 
@@ -37,9 +37,9 @@ module ProcessSettings
       def from_json_docs(filename, target_json_doc, settings_json_doc)
         target_json_doc = Target.new(target_json_doc)
 
-        process_settings = Settings.new(settings_json_doc)
+        settings = Settings.new(settings_json_doc)
 
-        new(filename, target_json_doc, process_settings)
+        new(filename, target_json_doc, settings)
       end
     end
 
@@ -49,7 +49,7 @@ module ProcessSettings
       if new_target == @target
         self
       else
-        self.class.new(@filename, new_target, @process_settings)
+        self.class.new(@filename, new_target, @settings)
       end
     end
   end

data/lib/process_settings/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Invoca
@@ -86,6 +86,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/Invoca/process_settings
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths: