process_settings 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4da1b4678116cf897726de9273822dadff5ffaf0
+  data.tar.gz: 6679ca9c2cfdf4f6022b5bb4121b09fd1956f640
+SHA512:
+  metadata.gz: bb07fcbffc25721635643c43f86b95bb7207e95cb058ddb046dde708961ebdf037536b99d1b2748b5df5b1f730c715cb2f91a7e511ac38596b6f2c7667825ef2
+  data.tar.gz: a7a28a9c6be634475492386f89730cf79ff00fbf6f403075315fa8717941da6edc18b2227b4b150b3bb57d0518bc048d9d53d7a6b1c00d3f021efbb0674a66e1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Invoca Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# ProcessSettings [![Build Status](https://travis-ci.org/Invoca/process_settings.svg?branch=master)](https://travis-ci.org/Invoca/process_settings) [![Coverage Status](https://coveralls.io/repos/github/Invoca/process_settings/badge.svg?branch=master)](https://coveralls.io/github/Invoca/process_settings?branch=master) [![Gem Version](https://badge.fury.io/rb/process_settings.svg)](https://badge.fury.io/rb/process_settings)
+This gem provides dynamic settings for Linux processes. These settings are stored in JSON.
+They including a targeting notation so that each settings group can be targeted based on matching context values.
+The context can be either static to the process (for example, service_name or data_center) or dynamic (for example, the domain of the current web request).
+
+## Installation
+To install this gem directly on your machine from rubygems, run the following:
+```ruby
+gem install process_settings
+```
+
+To install this gem in your bundler project, add the following to your Gemfile:
+```ruby
+gem 'process_settings', '~> 0.3'
+```
+
+To use an unreleased version, add it to your Gemfile for Bundler:
+```ruby
+gem 'process_settings', git: 'git@github.com:Invoca/process_settings'
+```
+
+## Usage
+### Initialization
+To use the contextual logger, all you need to do is initailize the object with your existing logger
+```ruby
+require 'process_settings'
+```
+
+TODO: Fill in here how to use the Monitor's instance method to get current settings, how to register for on_change callbacks, etc.
+
+### Dynamic Settings
+
+In order to load changes dynamically, `ProcessSettings` relies on INotify module of the Linux kernel. On kernels that do not have this module (MacOS for example), you will see a warning on STDERR that changes will not be loaded while the process runs.
+
+
+## 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/combine_process_settings

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'ostruct'
+require 'pathname'
+require 'fileutils'
+require 'yaml'
+require_relative '../lib/process_settings/targeted_settings'
+
+PROGRAM_NAME = File.basename($PROGRAM_NAME)
+SETTINGS_FOLDER = 'settings'
+
+def end_marker(version)
+  {
+    'meta' => {
+      'version' => version,
+      'END' => true
+    }
+  }
+end
+
+# returns a version number one higher than what's in the latest_output_file
+def default_version_number(latest_output_file)
+  process_settings = ProcessSettings::TargetedSettings.from_file(latest_output_file, only_meta: true)
+  process_settings.version + 1
+end
+
+
+def parse_options(argv)
+  options = OpenStruct.new
+  options.verbose = false
+  option_parser = OptionParser.new(argv) do |opt|
+    opt.on('-v', '--verbose', 'Verbose mode.') { options.verbose = true }
+    opt.on('-r', '--root_folder=ROOT') { |o| options.root_folder = o }
+    opt.on('-o', '--output=FILENAME', 'Output file.') { |o| options.output_filename = o }
+    opt.on('-i', '--initial=FILENAME', 'Initial settings file for version inference.') { |o| options.initial_filename = o }
+  end
+
+  if option_parser.parse! && options.root_folder && options.output_filename && (ENV['BUILD_NUMBER'] || options.initial_filename)
+    options
+  else
+    warn "usage: #{PROGRAM_NAME} -r staging|production -o combined_process_settings.yml [-i initial_combined_process_settings.yml] (required if BUILD_NUMBER not set)"
+    option_parser.summarize(STDERR)
+    exit(1)
+  end
+end
+
+def read_and_combine_settings(settings_folder)
+  pushd(settings_folder) do
+    Dir.glob("**/*.yml").sort.map do |settings_path|
+      settings = { 'filename' => settings_path }  # start with the filename so it appears at the top of each section
+      settings.merge!(YAML.load_file(settings_path))
+      settings
+    end
+  end
+end
+
+def pushd(folder)
+  pwd = FileUtils.pwd
+  FileUtils.cd(folder)
+  yield
+ensure
+  FileUtils.cd(pwd)
+end
+
+def add_warning_comment(yaml, root_folder, program_name, settings_folder)
+  warning_comment = <<~EOS
+  #
+  # Don't edit this file directly! It was generated by #{program_name} from the files in #{root_folder.split('/').last}/#{settings_folder}/.
+  #
+  EOS
+
+  yaml.sub("\n", "\n" + warning_comment)
+end
+
+#
+# main
+#
+
+options = parse_options(ARGV.dup)
+
+combined_settings = read_and_combine_settings(Pathname.new(options.root_folder) + SETTINGS_FOLDER)
+
+version_number = ENV['BUILD_NUMBER']&.to_i || default_version_number(options.initial_filename)
+combined_settings << end_marker(version_number)
+
+yaml = combined_settings.to_yaml
+yaml_with_warning_comment = add_warning_comment(yaml, options.root_folder, PROGRAM_NAME, SETTINGS_FOLDER)
+
+output_filename     = options.output_filename
+tmp_output_filename = "#{output_filename}.tmp"
+
+system("rm -f #{tmp_output_filename}")
+File.write(tmp_output_filename, yaml_with_warning_comment)
+
+system(<<~EOS)
+  if cmp #{tmp_output_filename} #{output_filename} --silent; then
+    #{"echo #{options.root_folder}: unchanged;" if options.verbose}
+    rm -f #{tmp_output_filename};
+  else
+    #{"echo #{options.root_folder}: UPDATING;" if options.verbose}
+    mv #{tmp_output_filename} #{output_filename};
+  fi
+EOS
+
+exit(0)

data/bin/diff_process_settings

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Diffs two combined_process_settings.yml files. Skips over the meta-data (version) at the END.
+# A filename of - means STDIN.
+
+require 'fileutils'
+
+PROGRAM_NAME = File.basename($PROGRAM_NAME)
+
+unless ARGV.size == 2
+  puts "usage: #{PROGRAM_NAME} <path-to-combined_process_settings-A.yml> <path-to-combined_process_settings-B.yml>"
+  exit 1
+end
+
+path_to_combine_process_settings = ARGV[0]
+
+input_files =
+    ARGV.map do |path|
+      if path == '-'
+        ''
+      else
+        unless File.exists?(path)
+          warn "#{path} not found--must be a path to combined_process_settings.yml"
+          exit 1
+        end
+        "< #{path}"
+      end
+    end
+
+system("rm -f tmp/combined_process_settings-A.yml tmp/combined_process_settings-B.yml")
+
+# remove the meta-data from the end
+system("sed '/^- meta:$/,$d' #{input_files[0]} > tmp/combined_process_settings-A.yml")
+system("sed '/^- meta:$/,$d' #{input_files[1]} > tmp/combined_process_settings-B.yml")
+
+system("diff tmp/combined_process_settings-A.yml tmp/combined_process_settings-B.yml")
+
+system("rm -f tmp/combined_process_settings-A.yml tmp/combined_process_settings-B.yml")

data/bin/process_settings_for_services

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#TODO: I need to add a test for this file. Probably by moving the algorithm into methods that are tested and leaving
+#TODO: this as a command line shell. -Colin
+
+require_relative '../lib/process_settings/targeted_settings'
+require_relative '../lib/process_settings/util'
+require 'yaml'
+require 'set'
+
+CORRELATION_KEYS = [
+  ['node'],
+  ['app'],
+  ['region'],
+  ['app', 'node'],
+  ['app', 'region'],
+  ['deployGroup'],
+  ['app', 'deployGroup']
+].freeze
+
+PROGRAM_NAME = File.basename($PROGRAM_NAME)
+
+def parse_options(argv)
+  if argv.size == 3
+    argv
+  else
+    warn "usage: #{PROGRAM_NAME} <path-to-flat_services.yml> <path-to-combined_process_settings-OLD.yml> <path-to-combined_process_settings-NEW.yml>"
+    exit(1)
+  end
+end
+
+
+#
+# main
+#
+path_to_flat_services_yml, path_to_combined_process_settings_yml_old, path_to_combined_process_settings_yml_new = parse_options(ARGV.dup)
+
+flat_services_yml_json_doc     = YAML.load_file(path_to_flat_services_yml)
+combined_process_settings_yml_json_doc_old = YAML.load_file(path_to_combined_process_settings_yml_old)
+combined_process_settings_yml_json_doc_new = YAML.load_file(path_to_combined_process_settings_yml_new)
+
+targeted_process_settings_old = ProcessSettings::TargetedSettings.from_array(combined_process_settings_yml_json_doc_old)
+targeted_process_settings_new = ProcessSettings::TargetedSettings.from_array(combined_process_settings_yml_json_doc_new)
+
+flat_services_with_targeted_settings = Hash.new { |h, service| h[service] = Hash.new { |h2, node| h2[node] = [] } }
+
+correlation_scorecard = Hash.new { |h, k| h[k] = { false => Set.new, true => Set.new } }
+
+flat_services_yml_json_doc.each do |service, nodes|
+  nodes.each do |node, pods|
+    pods.each_with_index do |pod_context, pod_index|
+      node_attrs = pod_context.dup
+      node_attrs['service']   = service
+      node_attrs['node']      = node
+      node_attrs['pod_index'] = pod_index if pods.size > 1
+      node_targeted_process_settings_old = targeted_process_settings_old.with_static_context(pod_context)
+      node_targeted_process_settings_new = targeted_process_settings_new.with_static_context(pod_context)
+
+      flat_services_with_targeted_settings[service][node] << node_attrs
+
+      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
+                      }
+                    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
+                      }
+                    end
+
+        changes_hash = node_attrs['__changes__'] = {
+          'old' => node_old,
+          'new' => node_new
+        }
+        changes_hash['pod_index'] = pod_index if pods.size > 1
+      end
+
+      CORRELATION_KEYS.each do |correlation_key|
+        scorecard = correlation_scorecard[correlation_key]
+
+        correlation_key_values = correlation_key.map { |key| { key => node_attrs[key] } }
+        scorecard[changed] << correlation_key_values
+        if changed
+          scorecard['__changes__'] = changes_hash
+          scorecard['__pods__'] ||= 0
+          scorecard['__pods__'] += 1
+        end
+      end
+    end
+  end
+end
+
+if correlation_scorecard.any? { |_correllation_key, scorecard| scorecard[true].any? }
+  perfect_correlations = correlation_scorecard.select do |_correllation_key, scorecard|
+    (scorecard[false] & scorecard[true]).empty?
+  end
+
+  if (best_correlation = perfect_correlations.min_by { |_correllation_key, scorecard| scorecard[true].size })
+    puts "#{best_correlation.last['__pods__']} pods"
+    puts best_correlation.last[true].to_a.first.to_yaml
+    puts "Diff:"
+    system("rm -f tmp/old.yml tmp/new.yml")
+    File.write("tmp/old.yml", ProcessSettings.plain_hash(best_correlation.last['__changes__']['old']).to_yaml)
+    File.write("tmp/new.yml", ProcessSettings.plain_hash(best_correlation.last['__changes__']['new']).to_yaml)
+    STDOUT << `diff tmp/old.yml tmp/new.yml`
+  else
+    puts "No best correlation found?"
+  end
+else
+  puts "No changes"
+end
+
+# puts flat_services_with_targeted_settings.to_yaml

data/bin/process_settings_version

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Pulls the version from a combined_process_settings.yml file and prints it on STDOUT.
+
+require_relative '../lib/process_settings/targeted_settings'
+
+PROGRAM_NAME = File.basename($PROGRAM_NAME)
+
+unless ARGV.size == 1
+  puts "usage: #{PROGRAM_NAME} <path-to-combined_process_settings.yml>"
+  exit 1
+end
+
+targeted_settings = ProcessSettings::TargetedSettings.from_file(ARGV[0], only_meta: true)
+
+puts targeted_settings.version

data/lib/process_settings/hash_path.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+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']
+  module HashPath
+    def [](key)
+      if key.is_a?(Hash)
+        HashPath.hash_at_path(self, key)
+      else
+        super
+      end
+    end
+
+    class << self
+      def hash_at_path(hash, path)
+        if path.is_a?(Hash)
+          case path.size
+          when 0
+            hash
+          when 1
+            path_key, path_value = path.first
+            if (remaining_hash = hash[path_key])
+              remaining_path = path_value
+              hash_at_path(remaining_hash, remaining_path)
+            end
+          else
+            raise ArgumentError, "path may have at most 1 key (got #{path.inspect})"
+          end
+        else
+          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/hash_with_hash_path.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'hash_path'
+
+module ProcessSettings
+  class HashWithHashPath < Hash
+    prepend HashPath
+  end
+end

data/lib/process_settings/monitor.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require_relative 'targeted_settings'
+require_relative 'hash_path'
+require 'psych'
+require 'listen'
+require 'active_support'
+
+module ProcessSettings
+  class Monitor
+    attr_reader :file_path, :min_polling_seconds
+    attr_reader :static_context, :untargeted_settings, :statically_targeted_settings
+
+    DEFAULT_MIN_POLLING_SECONDS = 5
+
+    def initialize(file_path, logger:)
+      @file_path = File.expand_path(file_path)
+      @logger = logger
+      @on_change_callbacks = []
+      @static_context = {}
+
+      # to eliminate any race condition:
+      # 1. set up file watcher
+      # 2. start it
+      # 3. load the file
+      # 4. run the watcher (which should trigger if any changes have been made since (2))
+
+      path = File.dirname(@file_path)
+
+      @listener = file_change_notifier.to(path) do |modified, _added, _removed|
+        if modified.include?(@file_path)
+          @logger.info("ProcessSettings::Monitor file #{@file_path} changed. Reloading.")
+          load_untargeted_settings
+        end
+      end
+
+      @listener.start
+
+      load_untargeted_settings
+    end
+
+    # stops listening for changes
+    def stop
+      @listener.stop
+    end
+
+    # Registers the given callback block to be called when settings change.
+    # These are run using the shared thread that monitors for changes so be courteous and don't monopolize it!
+    def on_change(&callback)
+      @on_change_callbacks << callback
+    end
+
+    # Loads the most recent settings from disk and returns them.
+    def load_untargeted_settings
+      @untargeted_settings = load_file(file_path)
+    end
+
+    # Assigns a new static context. Recomputes statically_targeted_settings.
+    def static_context=(context)
+      @static_context = context
+
+      statically_targeted_settings(force: true)
+    end
+
+    # Loads the latest untargeted settings from disk. Returns the current process settings as a TargetAndProcessSettings given
+    # by applying the static context to the current untargeted settings from disk.
+    # If these have changed, borrows this thread to call notify_on_change.
+    def statically_targeted_settings(force: false)
+      if force || @last_untargetted_settings != @untargeted_settings
+        @statically_targeted_settings = @untargeted_settings.with_static_context(@static_context)
+        @last_untargetted_settings = @untargeted_settings
+
+        notify_on_change
+      end
+
+      @statically_targeted_settings
+    end
+
+    # 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)
+      # 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|
+        # 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
+          end
+        end
+        result
+      end
+    end
+
+    class << self
+      attr_accessor :file_path
+      attr_reader :logger
+
+      def clear_instance
+        @instance = nil
+      end
+
+      def instance
+        file_path or raise ArgumentError, "#{self}::file_path must be set before calling instance method"
+        logger or raise ArgumentError, "#{self}::logger must be set before calling instance method"
+        @instance ||= new(file_path, logger: logger)
+      end
+
+      def logger=(new_logger)
+        @logger = new_logger
+        Listen.logger = new_logger
+      end
+    end
+
+    private
+
+    def notify_on_change
+      @on_change_callbacks.each do |callback|
+        begin
+          callback.call(self)
+        rescue => ex
+          logger.error("ProcessSettings::Monitor#notify_on_change rescued exception:\n#{ex.class}: #{ex.message}")
+        end
+      end
+    end
+
+    def load_file(file_path)
+      TargetedSettings.from_file(file_path)
+    end
+
+    def file_change_notifier
+      Listen
+    end
+  end
+end

data/lib/process_settings/replace_versioned_file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'targeted_settings'
+
+module ProcessSettings
+  # This class will override a file with a higher version file; it accounts for minor version number use
+  class ReplaceVersionedFile
+
+    def replace_file_on_newer_file_version(source_file_name, destination_file_name)
+      if source_version_is_newer?(source_file_name, destination_file_name)
+        FileUtils.mv(source_file_name, destination_file_name)
+      elsif source_file_name != destination_file_name # make sure we're not deleting destination file
+        FileUtils.remove_file(source_file_name) # clean up, remove left over file
+      end
+    end
+
+    private
+
+    def source_version_is_newer?(source_file_name, destination_file_name)
+      source_version      = ProcessSettings::TargetedSettings.from_file(source_file_name, only_meta: true).version
+      destination_version = ProcessSettings::TargetedSettings.from_file(destination_file_name, only_meta: true).version
+
+      Gem::Version.new(source_version) > Gem::Version.new(destination_version)
+    end
+  end
+end

data/lib/process_settings/settings.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'hash_with_hash_path'
+
+module ProcessSettings
+  class Settings
+    include Comparable
+
+    attr_reader :json_doc
+
+    def initialize(json_doc)
+      json_doc.is_a?(Hash) or raise ArgumentError, "ProcessSettings must be a Hash; got #{json_doc.inspect}"
+
+      @json_doc = HashWithHashPath[json_doc]
+    end
+
+    def ==(rhs)
+      json_doc == rhs.json_doc
+    end
+
+    def eql?(rhs)
+      self == rhs
+    end
+
+    def [](key)
+      @json_doc[key]
+    end
+  end
+end

data/lib/process_settings/target.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module ProcessSettings
+  class Target
+    include Comparable
+
+    attr_reader :json_doc
+
+    def initialize(json_doc)
+      @json_doc = json_doc
+    end
+
+    def target_key_matches?(context_hash)
+      @json_doc == {} || self.class.target_key_matches?(@json_doc, context_hash)
+    end
+
+    def with_static_context(static_context_hash)
+      new_json_doc = self.class.with_static_context(@json_doc, static_context_hash)
+      self.class.new(new_json_doc)
+    end
+
+    def ==(rhs)
+      json_doc == rhs.json_doc
+    end
+
+    def eql?(rhs)
+      self == rhs
+    end
+
+    class << self
+      def with_static_context(target_value, static_context_hash)
+        case target_value
+        when Array
+          with_static_context_array(target_value, static_context_hash)
+        when Hash
+          with_static_context_hash(target_value, static_context_hash)
+        when true, false
+          !target_value == !static_context_hash
+        else
+          target_value == static_context_hash
+        end
+      end
+
+      private
+
+      def with_static_context_array(target_value, static_context_hash)
+        target_value.any? do |value|
+          with_static_context(value, static_context_hash)
+        end
+      end
+
+      def with_static_context_hash(target_value, static_context_hash)
+        result = target_value.reduce({}) do |hash, (key, value)|
+          if static_context_hash.has_key?(key)
+            context_at_key = static_context_hash[key]
+            sub_value = with_static_context(value, context_at_key)
+            case sub_value
+            when true   # this hash entry is true, so omit it
+            when false  # this hash entry is false, so hash is false
+              return false
+            else
+              raise ArgumentError, "Got #{sub_value.inspect}???"
+            end
+          else
+            hash[key] = value
+          end
+          hash
+        end
+
+        if result.any?
+          result
+        else
+          true
+        end
+      end
+
+      public
+
+      def target_key_matches?(target_value, context_hash)
+        case target_value
+        when Array
+          target_value.any? { |value| target_key_matches?(value, context_hash) }
+        when Hash
+          target_value.all? do |key, value|
+            if (context_at_key = context_hash[key])
+              target_key_matches?(value, context_at_key)
+            end
+          end
+        when true, false
+          target_value
+        else
+          target_value == context_hash
+        end
+      end
+    end
+  end
+end

data/lib/process_settings/target_and_settings.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'target'
+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
+
+    def initialize(filename, target, settings)
+      @filename = filename
+
+      target.is_a?(Target) or raise ArgumentError, "target must be a ProcessTarget; got #{target.inspect}"
+      @target = target
+
+      settings.is_a?(Settings) or raise ArgumentError, "settings must be a ProcessSettings; got #{settings.inspect}"
+      @process_settings = settings
+    end
+
+    def ==(rhs)
+      to_json_doc == rhs.to_json_doc
+    end
+
+    def eql?(rhs)
+      self == rhs
+    end
+
+    def to_json_doc
+      {
+        "target" => @target.json_doc,
+        "settings" => @process_settings.json_doc
+      }
+    end
+
+    class << self
+      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)
+
+        new(filename, target_json_doc, process_settings)
+      end
+    end
+
+    # returns a copy of self with target simplified based on given static_context_hash (or returns self if there is no difference)
+    def with_static_context(static_context_hash)
+      new_target = target.with_static_context(static_context_hash)
+      if new_target == @target
+        self
+      else
+        self.class.new(@filename, new_target, @process_settings)
+      end
+    end
+  end
+end

data/lib/process_settings/targeted_settings.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative 'target_and_settings'
+
+module ProcessSettings
+  # This class encapsulates an ordered collection of TargetAndSettings (each of which came from one YAML file).
+  class TargetedSettings
+    KEY_NAMES = ["filename", "target", "settings"].freeze
+
+    attr_reader :targeted_settings_array, :version
+
+    def initialize(targeted_settings_array, version:)
+      targeted_settings_array.is_a?(Array) or raise ArgumentError, "targeted_settings_array must be an Array of Hashes; got #{targeted_settings_array.inspect}"
+      targeted_settings_array.each do |target_and_settings|
+        target_and_settings.is_a?(TargetAndSettings) or
+          raise ArgumentError, "targeted_settings_array entries must each be a TargetAndProcessSettings; got #{target_and_settings.inspect}"
+      end
+
+      @targeted_settings_array = targeted_settings_array
+
+      @version = version or raise ArgumentError, "version must not be empty"
+    end
+
+    def ==(rhs)
+      to_json_doc == rhs.to_json_doc
+    end
+
+    def eql?(rhs)
+      self == rhs
+    end
+
+    def to_json_doc
+      @targeted_settings_array.map(&:to_json_doc)
+    end
+
+    def to_yaml
+      to_json_doc.to_yaml
+    end
+
+    class << self
+      def from_array(settings_array, only_meta: false)
+        settings_array.is_a?(Array) or raise ArgumentError, "settings_array must be an Array of Hashes; got #{settings_array.inspect}"
+        meta_hash = nil
+
+        targeted_settings_array =
+          settings_array.map do |settings_hash|
+            settings_hash.is_a?(Hash) or raise ArgumentError, "settings_array entries must each be a Hash; got #{settings_hash.inspect}"
+
+            meta_hash and raise ArgumentError, "\"meta\" marker must be at end; got #{settings_hash.inspect} after"
+            if (meta_hash = settings_hash["meta"])
+              meta_hash.to_a.last == ['END', true] or raise ArgumentError, "END: true must be at end of file; got #{meta_hash.inspect}"
+              next
+            end
+
+            unless only_meta
+              filename               = settings_hash["filename"]
+              target_settings_hash   = settings_hash["target"] || true
+              settings_settings_hash = settings_hash["settings"]
+
+              settings_settings_hash or raise ArgumentError, "settings_array entries must each have 'settings' hash: #{settings_hash.inspect}"
+
+              (extra_keys = settings_hash.keys - KEY_NAMES).empty? or
+                raise ArgumentError, "settings_array entries must each have exactly these keys: #{KEY_NAMES.inspect}; got these extras: #{extra_keys.inspect}\nsettings_hash: #{settings_hash.inspect}"
+
+              TargetAndSettings.from_json_docs(filename, target_settings_hash, settings_settings_hash)
+            end
+          end.compact
+
+        meta_hash or raise ArgumentError, "Missing meta: marker at end; got #{settings_array.inspect}"
+
+        new(targeted_settings_array, version: meta_hash['version'])
+      end
+
+      def from_file(file_path, only_meta: false)
+        json_doc = Psych.load_file(file_path)
+        from_array(json_doc, only_meta: only_meta)
+      end
+    end
+
+    def matching_settings(context_hash)
+      @targeted_settings_array.select do |target_and_settings|
+        target_and_settings.target.target_key_matches?(context_hash)
+      end
+    end
+
+    # returns the collection of targeted_settings with target simplified based on given static_context_hash
+    # omits entries whose targeting is then false
+    def with_static_context(static_context_hash)
+      @targeted_settings_array.map do |target_and_settings|
+        new_target_and_process_settings = target_and_settings.with_static_context(static_context_hash)
+        new_target_and_process_settings if new_target_and_process_settings.target.json_doc
+      end.compact
+    end
+
+    def settings_with_static_context(static_context_hash)
+      result_settings =
+        @settings_array.map do |target_and_settings|
+          if (new_target = target.with_static_context(static_context_hash))
+            TargetAndSettings.new(new_target, target_and_settings.settings)
+          end
+        end.compact
+
+      self.class.new(result_settings)
+    end
+  end
+end

data/lib/process_settings/util.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ProcessSettings
+  class << self
+    def plain_hash(json_doc)
+      case json_doc
+      when Hash
+        result = {}
+        json_doc.each { |key, value| result[key] = plain_hash(value) }
+        result
+      when Array
+        json_doc.map { |value| plain_hash(value) }
+      else
+        if json_doc.respond_to?(:json_doc)
+          plain_hash(json_doc.json_doc)
+        else
+          json_doc
+        end
+      end
+    end
+  end
+end

data/lib/process_settings.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ProcessSettings
+end
+
+require 'process_settings/monitor'
+
+module ProcessSettings
+  class << self
+    def [](value, dynamic_context = {})
+      Monitor.instance.targeted_value(value, dynamic_context)
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: process_settings
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Colin Kelley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Targed process settings that dynamically reload without restarting the
+  process
+email: colin@invoca.com
+executables:
+- combine_process_settings
+- diff_process_settings
+- process_settings_for_services
+- process_settings_version
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/combine_process_settings
+- bin/diff_process_settings
+- bin/process_settings_for_services
+- bin/process_settings_version
+- lib/process_settings.rb
+- lib/process_settings/hash_path.rb
+- lib/process_settings/hash_with_hash_path.rb
+- lib/process_settings/monitor.rb
+- lib/process_settings/replace_versioned_file.rb
+- lib/process_settings/settings.rb
+- lib/process_settings/target.rb
+- lib/process_settings/target_and_settings.rb
+- lib/process_settings/targeted_settings.rb
+- lib/process_settings/util.rb
+homepage: https://rubygems.org/gems/process_settings
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Invoca/process_settings
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Dynamic process settings
+test_files: []