process_settings 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93261c11e45446632a8a1ccead49e7eb6671cd3a8543488103b6ae3764c97804
-  data.tar.gz: 949bf56302c900a057661c1d91fec7cb15f2ebc6f888e351ec25d0be4702ec0c
+  metadata.gz: 0763f49b68a52e5858cf539fc18adaa575d0e374b3f0490e63c972b340dc75ab
+  data.tar.gz: d8d82eb1674afbfaa0ffd1e94b12555af51811c73f84f8cb3ebf11e0f6602581
 SHA512:
-  metadata.gz: b510569576c842eafa5bbcf9fbad51c5677c649301b5db786f0a4d5658ed5ad7664f7fccc53568f8874b957e9b319ebcdaebf003935eb7dc563417075c24e825
-  data.tar.gz: d9c72be3f0081e85f7c3e03c7ddfcba2132e38cc65488628a88c2d40271bf29fc15aafb2e9e0a8d62f7ee9ac1c0a97a0d507e779fcbab87e5218e5c8041e0454
+  metadata.gz: 506febcd2fee4fec9e19f44e3de774a2ea2878526b80e93e71f3f51eab6ff807983914f998a0576c294b9b0e8bda6d47a7cc81704fa59ef8514f61cd0d1e1e97
+  data.tar.gz: 2e2d84671c400c0c9a1711957e33c6757fe1420879cf4f830ba167592d3cb1420c8f345df46189de4be299480b63772609531ef25761a37f0318b9e53ab358e7

data/lib/process_settings/monitor.rb

@@ -31,6 +31,33 @@ module ProcessSettings
       start
     end
 
+    # []
+    #
+    # This is the main entry point for looking up settings on the Monitor instance.
+    #
+    # @example
+    #
+    # ['path', 'to', 'setting']
+    #
+    # will return 42 in this example settings YAML:
+    # +code+
+    #   path:
+    #     to:
+    #       setting:
+    #         42
+    # +code+
+    #
+    # @param [Array(String)] path The path of one or more strings.
+    #
+    # @param [Hash] dynamic_context Optional dynamic context hash. It will be merged with the static context.
+    #
+    # @param [boolean] required If true (default) will raise `SettingsPathNotFound` if not found; otherwise returns `nil` if not found.
+    #
+    # @return setting value
+    def [](*path, dynamic_context: {}, required: true)
+      targeted_value(*path, dynamic_context: dynamic_context, required: required)
+    end
+
     # starts listening for changes
     # Note: This method creates a new thread that will be monitoring for changes
     #       do to the nature of how the Listen gem works, there is no record of

data/lib/process_settings/version.rb

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

data/lib/process_settings.rb

@@ -7,8 +7,31 @@ require 'process_settings/monitor'
 
 module ProcessSettings
   class << self
+    # []
+    #
+    # This is the main entry point for looking up settings in the process.
+    #
+    # @example
+    #
+    # ProcessSettings['path', 'to', 'setting']
+    #
+    # will return 42 in this example settings YAML:
+    # +code+
+    #   path:
+    #     to:
+    #       setting:
+    #         42
+    # +code+
+    #
+    # @param [Array(String)] path The path of one or more strings.
+    #
+    # @param [Hash] dynamic_context Optional dynamic context hash. It will be merged with the static context.
+    #
+    # @param [boolean] required If true (default) will raise `SettingsPathNotFound` if not found; otherwise returns `nil` if not found.
+    #
+    # @return setting value
     def [](*path, dynamic_context: {}, required: true)
-      Monitor.instance.targeted_value(*path, dynamic_context: dynamic_context, required: required)
+      Monitor.instance[*path, 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.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Invoca