process_settings 0.13.0 → 0.14.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73aea1798bdb8d5624c5f66dc1c2282a53b1c32fce2409983b35429a7a7432c7
-  data.tar.gz: c6e2d24b5e79ec87a94e6bda783a9f933ae1ab3282c5f9d8291f2f873cdd4840
+  metadata.gz: 0f741a9ba0e6370251e742c613fe5dba63b4c53c7dfdec8c352d00f9d2938489
+  data.tar.gz: 69b58c50ff369b61d95814cba575fad95d8eb3404443acfb2f5d4154aea392c4
 SHA512:
-  metadata.gz: e9ad1f070f4c9606ce7608c03d1db0345e290c945706883c04918b99910ab8985dec1505664844f5d2c15cfe6cbed9d7e77700a01d94096df0fb9204ad52555e
-  data.tar.gz: 3284db9c4250ac716e4c89cbdde718e5a1d079f97e99ca33925c6a1d537c6a50dd5beb5044af96f61cbd32bce8af6dabea8fdf193e71a480cbab818963ba2e59
+  metadata.gz: d00a43c0beffc30ab1af86edebc98adb7dc99dcc21d334dc7ba13cb146b5595e04bb905c6ce346a057ea29f2483fa729e52cdaaacb45eb743f0740fb062fdcf9
+  data.tar.gz: 97ebec348ff8d4220668b55148cb26aa5c3934317e91d114ecbeb5e2e2c7cc081bfa695595b09ee8b9ac984b1c58955346697eda2ef78b36e6ea7bab1a8e6491

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

@@ -10,7 +10,6 @@ require_relative '../lib/process_settings/targeted_settings'
 
 PROGRAM_NAME = File.basename($PROGRAM_NAME)
 SETTINGS_FOLDER = 'settings'
-MINIMUM_LIBYAML_VERSION = Gem::Version.new('0.2.6') # So that null (nil) values don't have trailing spaces.
 
 def end_marker(version)
   {
@@ -76,20 +75,21 @@ def add_warning_comment(yaml, root_folder, program_name, settings_folder)
   yaml.sub("\n", "\n" + warning_comment)
 end
 
-def check_libyaml_version
-  Gem::Version.new(Psych::LIBYAML_VERSION) >= MINIMUM_LIBYAML_VERSION or
+MINIMUM_LIBYAML_VERSION = '0.2.5' # So that null (nil) values don't have trailing spaces.
+
+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:
-  
-          brew update && upgrade libyaml
-  
+      #{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 && brew upgrade libyaml
+
       You may also need:
-  
+
           gem install psych -- --enable-bundled-libyaml
     EOS
-
-  exit(1)
+  end
 end
 
 
@@ -97,16 +97,16 @@ end
 # main
 #
 
-check_libyaml_version
-
 options = parse_options(ARGV.dup)
 
+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.0'
+  VERSION = '0.14.0.pre.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0.pre.1
 platform: ruby
 authors:
 - Invoca
@@ -122,9 +122,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: