process_settings 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60447e2f039f0d12d6f35a21b8b823c9f9dea2294900c0d3310ccf40dfe0a3e1
-  data.tar.gz: dceadf48d13853e709d5b35bfd5740551cc3baabd4df07e0d3b64c855f5caba7
+  metadata.gz: d6719811e3b27382e1c3ab6872a6dc3775b6a06c1971ac980d62f0130252d66e
+  data.tar.gz: d206be34980dd24cf6dd413d8db0e8e63a4b49409ff392135fada36bb68c4295
 SHA512:
-  metadata.gz: d33df4bfb607626f41f8c0059b821caab6b6f50a900aef9a6aefd5f6e47c562e44d5c32f75b99412e22c7375c74dbf39c37c4e0812896f1ac84363b2b01bfe84
-  data.tar.gz: 18a90e814c09e2666da73970998a8eda9bca90fe216ef7bf4c7d2b463cafb77b42a2ba07e478eaaca186f422a43b4a4859c2ea7ba56a647a6ff66621fb1fefd1
+  metadata.gz: bc5ba17baca2d071bd68aed1a685d223e0febe073463e46344d314003004948463e7e9da400198ad45a075a599aff7bd34a6989f4223e598ea014026e611ab18
+  data.tar.gz: cee3d3980e62c840c061df1e8f5d44aec487c855d49b467d81b7bf52f5d48cf61f02ef97759a7eb1b43b575db39beee0f73849fe36f5069976adb35f17deff0b

data/README.md

@@ -169,8 +169,8 @@ 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 leaving the rest intact, and resetting back to the defaults
+that use case.  The `ProcessSettings::Testing::RSpec::Helpers` and `ProcessSettings::Testing::Minitest::Helpers` modules are provided for this purpose.
+They can be used to 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
@@ -181,7 +181,7 @@ require 'process_settings/testing/helpers'
 RSpec.configure do |config|
   # ...
 
-  include ProcessSettings::Testing::Helpers
+  include ProcessSettings::Testing::RSpec::Helpers
 
   # Note: the include above will automatically register a global after block that will reset process_settings to their initial values.
   # ...
@@ -206,7 +206,7 @@ end
 require 'process_settings/testing/helpers'
 
 context SomeClass do
-  include ProcessSettings::Testing::Helpers
+  include ProcessSettings::Testing::Minitest::Helpers
 
   # Note: the include above will automatically register a teardown block that will reset process_settings to their initial values.
 

data/bin/combine_process_settings

@@ -77,20 +77,18 @@ end
 
 MINIMUM_LIBYAML_VERSION = '0.2.5' # So that null (nil) values don't have trailing spaces.
 
-def check_libyaml_version
+def warn_if_old_libyaml_version
   if Gem::Version.new(Psych::LIBYAML_VERSION) < Gem::Version.new(MINIMUM_LIBYAML_VERSION)
     warn <<~EOS
 
-      #{PROGRAM_NAME} error: libyaml version #{Psych::LIBYAML_VERSION} must be at least #{MINIMUM_LIBYAML_VERSION}. Try:
+      #{PROGRAM_NAME} warning: libyaml version #{Psych::LIBYAML_VERSION} is out of date; it should be at least #{MINIMUM_LIBYAML_VERSION}. On a Mac, try:
 
-          brew update && upgrade libyaml
+          brew update && brew upgrade libyaml
 
       You may also need:
 
           gem install psych -- --enable-bundled-libyaml
     EOS
-
-    exit(1)
   end
 end
 
@@ -101,14 +99,14 @@ end
 
 options = parse_options(ARGV.dup)
 
-check_libyaml_version
+warn_if_old_libyaml_version
 
 combined_settings = read_and_combine_settings(Pathname.new(options.root_folder) + SETTINGS_FOLDER)
 
 version_number = options.version || default_version_number(options.initial_filename)
 combined_settings << end_marker(version_number)
 
-yaml = combined_settings.to_yaml
+yaml = combined_settings.to_yaml.gsub(/: $/, ':') # libyaml before 0.2.5 wrote trailing space for nil
 yaml_with_warning_comment = add_warning_comment(yaml, options.root_folder, PROGRAM_NAME, SETTINGS_FOLDER)
 
 output_filename     = options.output_filename

data/lib/process_settings/testing/helpers.rb

@@ -8,48 +8,66 @@ 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
+    module Base
+      module Helpers
+        # 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.
+        #
+        # @param [Hash] settings_hash
+        #
+        # @return none
+        def stub_process_settings(settings_hash)
+          new_target_and_settings = ProcessSettings::TargetAndSettings.new(
+            '<test_override>',
+            Target::true_target,
+            ProcessSettings::Settings.new(settings_hash.deep_stringify_keys)
+          )
 
-          including_klass.send(after_method) do
-            ProcessSettings.instance = initial_instance
-          end
+          new_process_settings = [
+            *initial_instance.statically_targeted_settings,
+            new_target_and_settings
+          ]
+
+          ProcessSettings.instance = ProcessSettings::Testing::Monitor.new(
+            new_process_settings,
+            logger: initial_instance.logger
+          )
+        end
+
+        def initial_instance
+          @initial_instance ||= ProcessSettings.instance
         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.
-      #
-      # @param [Hash] settings_hash
-      #
-      # @return none
-      def stub_process_settings(settings_hash)
-        new_target_and_settings = ProcessSettings::TargetAndSettings.new(
-          '<test_override>',
-          Target::true_target,
-          ProcessSettings::Settings.new(settings_hash.deep_stringify_keys)
-        )
-
-        new_process_settings = [
-          *initial_instance.statically_targeted_settings,
-          new_target_and_settings
-        ]
-
-        ProcessSettings.instance = ProcessSettings::Testing::Monitor.new(
-          new_process_settings,
-          logger: initial_instance.logger
-        )
+    end
+
+    module RSpec
+      module Helpers
+        include Base::Helpers
+
+        class << self
+          def included(including_klass)
+            including_klass.after do
+              ProcessSettings.instance = initial_instance
+            end
+          end
+        end
       end
+    end
+
+    module Minitest
+      module Helpers
+        include Base::Helpers
 
-      def initial_instance
-        @initial_instance ||= ProcessSettings.instance
+        class << self
+          def included(including_klass)
+            including_klass.define_method(:teardown) do
+              ProcessSettings.instance = initial_instance
+            end
+          end
+        end
       end
     end
+
+    Helpers = RSpec::Helpers  # for backward-compatibility
   end
 end

data/lib/process_settings/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Invoca