process_settings 0.4.0.pre.3 → 0.4.0.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35f7f59386045aa27ee3134236eed4d9681090b3
-  data.tar.gz: b9fa6bdfffe65b11b6858b9826a09dfc8de990bd
+  metadata.gz: 140a1442c24610ff86f42711e259fa20c478474f
+  data.tar.gz: '09b7c3fe96b5fd206d314aa7652671777c44198a'
 SHA512:
-  metadata.gz: 173134db7642f5e1622b6c640c12b7c4ef3024bc328bf215fe3cc613b71d47651e068c73504f83af546d2c9cd09085d73d8f3878e86e48a3ec215ac3fa8e50ee
-  data.tar.gz: 6c910bd0d0372e2c0e41dcd274732dbb3a60e0ac8ad1e9e2998a495c9a438c321c6fc6fba136911ff01416d3e5a6ffbb5db8e71fe091c2800665fcd6d1e6a811
+  metadata.gz: 2f922878b0de99a81164c846b148d8f81ac7b73746f93bddc61cda010f550a6b89021cdf89188e5e67b07281117dbfb29894f24bc417e4f0c8d46da1c1d4d811
+  data.tar.gz: fe802ec5e18e6fcf4fc0783067ff76e4a5a4fe0e888da9b2bba7f91d8da58d4f873bb76cd965fb50f46afa261ee37a085f6d4256e6fa7f61978704f996551a8f

data/lib/process_settings/hash_path.rb

@@ -2,13 +2,24 @@
 
 module ProcessSettings
   # Module for mixing into `Hash` or other class with `[]` that you want to be able to index
-  # with a hash path like:  hash['app.service_name' => 'frontend']
+  # with a hash path like:  hash.mine('honeypot', 'answer_odds')
   module HashPath
-    def [](key)
-      if key.is_a?(Hash)
-        HashPath.hash_at_path(self, key)
-      else
-        super
+    # returns the value found at the given path
+    # if the path is not found:
+    #   if a block is given, it is called and its value returned (may also raise an exception from the block)
+    #   else, the not_found_value: is returned
+    def mine(*path_array, not_found_value: nil)
+      path_array.is_a?(Enumerable) && path_array.size > 0 or raise ArgumentError, "path must be 1 or more keys; got #{path_array.inspect}"
+      path_array.reduce(self) do |hash, key|
+        if hash.has_key?(key)
+          hash[key]
+        else
+          if block_given?
+            break yield
+          else
+            break not_found_value
+          end
+        end
       end
     end
 
@@ -31,24 +42,6 @@ module ProcessSettings
           hash[path]
         end
       end
-
-      def set_hash_at_path(hash, path)
-        path.is_a?(Hash) or raise ArgumentError, "got unexpected non-hash value (#{hash[path]}"
-        case path.size
-        when 0
-          hash
-        when 1
-          path_key, path_value = path.first
-          if path_value.is_a?(Hash)
-            set_hash_at_path(remaining_hash, remaining_path)
-          else
-            hash[path_key] = path_value
-          end
-        else
-          raise ArgumentError, "path may have at most 1 key (got #{path.inspect})"
-        end
-        hash
-      end
     end
   end
 end

data/lib/process_settings/monitor.rb

@@ -7,6 +7,8 @@ require 'listen'
 require 'active_support'
 
 module ProcessSettings
+  class SettingsPathNotFound < StandardError; end
+
   class Monitor
     attr_reader :file_path, :min_polling_seconds, :logger
     attr_reader :static_context, :untargeted_settings, :statically_targeted_settings
@@ -26,8 +28,8 @@ module ProcessSettings
 
       path = File.dirname(@file_path)
 
-      @listener = file_change_notifier.to(path) do |modified, _added, _removed|
-        if modified.include?(@file_path)
+      @listener = file_change_notifier.to(path) do |modified, added, _removed|
+        if modified.include?(@file_path) || added.include?(@file_path)
           @logger.info("ProcessSettings::Monitor file #{@file_path} changed. Reloading.")
           load_untargeted_settings
 
@@ -62,20 +64,32 @@ module ProcessSettings
 
     # Returns the process settings value at the given `path` using the given `dynamic_context`.
     # (It is assumed that the static context was already set through static_context=.)
-    # Returns `nil` if nothing set at the given `path`.
-    def targeted_value(path, dynamic_context)
+    # If nothing set at the given `path`:
+    #   if required, raises SettingsPathNotFound
+    #   else returns nil
+    def targeted_value(path, dynamic_context:, required: true)
       # Merging the static context in is necessary to make sure that the static context isn't shifting
       # this can be rather costly to do every time if the dynamic context is not changing
       # TODO: Warn in the case where dynamic context was attempting to change a static value
       # TODO: Cache the last used dynamic context as a potential optimization to avoid unnecessary deep merges
       full_context = dynamic_context.deep_merge(static_context)
-      statically_targeted_settings.reduce(nil) do |result, target_and_settings|
+      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)
-          unless (value = HashPath.hash_at_path(target_and_settings.process_settings, path)).nil?
-            result = value
+          if (value = target_and_settings.process_settings.json_doc.mine(*path, not_found_value: :not_found)) != :not_found
+            latest_result = value
           end
         end
+        latest_result
+      end
+
+      if result == :not_found
+        if required
+          raise SettingsPathNotFound, "no settings found for path #{path.inspect}"
+        else
+          nil
+        end
+      else
         result
       end
     end

data/lib/process_settings/settings.rb

@@ -21,9 +21,5 @@ module ProcessSettings
     def eql?(rhs)
       self == rhs
     end
-
-    def [](key)
-      @json_doc[key]
-    end
   end
 end

data/lib/process_settings/version.rb

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

data/lib/process_settings.rb

@@ -7,8 +7,8 @@ require 'process_settings/monitor'
 
 module ProcessSettings
   class << self
-    def [](value, dynamic_context = {})
-      Monitor.instance.targeted_value(value, dynamic_context)
+    def [](value, dynamic_context: {}, required: true)
+      Monitor.instance.targeted_value(value, dynamic_context: dynamic_context, required: required)
     end
   end
 end

metadata

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