ndr_support 5.9.6 → 5.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7447cd235fe9715cc6e6c868b0f0048c7ec516b70ea88e323dcdc1fd01e24f11
-  data.tar.gz: 16b4237428fdf1258327ebc86928c4f3cc8db292289ff8151db364f77c505439
+  metadata.gz: 219d266e0a79fb3e013249e574aa25648ddecd15b49421cd66c06780d63f47e8
+  data.tar.gz: 48cdd5789a4aed8be6c03993eb4d1ce7ec6bf7e5225aea7e47f5e452c641d3d0
 SHA512:
-  metadata.gz: 186d4b1f8f053e9fa2cba311d7f9760e496ea8597dbea5c7e3e1d34c62fe6237df8c51692ff40a18f98085b58dc9a98942a54b94854b0e32ea30e4033e9d9aa3
-  data.tar.gz: 68ada778e3d6d7b9187f5b95398f408ff08940e0c77f5019a99611279ff4e1bbb9a5bfacd32ed3c0082bfb607ecc93df158ef2399b414d53a0e0bc7c53c0727a
+  metadata.gz: 869d57040385f645aae2c5b1c8dcefe5c2fd2176a7f8aa71f2859764edc7d9e0553a76065a92d29f98e3e1eb2bf29c6f8c1f0ee289e3314c90e0e105112f1cd6
+  data.tar.gz: dc2263d789b440b4a153c086b7049b5983e512af444fbb7f469161967685bbe4e130e7a68e63e5e14e5f4e494804a049f662fbd973e6588dddbb3a6065452902

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ## [Unreleased]
 * No unreleased changes
 
+## 5.9.7 / 2023-11-16
+## Fixed
+* YAMLSupport should preserve escaped backslashes in YAML text
+
 ## 5.9.6 / 2023-11-14
 ## Fixed
 * YAMLSupport should preserve escape sequences in JSON text

data/code_safety.yml

@@ -23,7 +23,7 @@ file safety:
   CHANGELOG.md:
     comments:
     reviewed_by: brian.shand
-    safe_revision: '09ad2e0c210d3e4377de68dac3d54932df6c1994'
+    safe_revision: ead7b5fe38f4f580d5c4ca2697136acc8ef1bd8b
   CODE_OF_CONDUCT.md:
     comments:
     reviewed_by: timgentry
@@ -171,7 +171,7 @@ file safety:
   lib/ndr_support/version.rb:
     comments:
     reviewed_by: brian.shand
-    safe_revision: 26236a310377036e1a27eb9534b4167430da6f3c
+    safe_revision: 9a91fe5935711475449aebbb6b93bd9f40884a77
   lib/ndr_support/working_days.rb:
     comments:
     reviewed_by: josh.pencheon
@@ -179,7 +179,7 @@ file safety:
   lib/ndr_support/yaml/serialization_migration.rb:
     comments:
     reviewed_by: brian.shand
-    safe_revision: '09ad2e0c210d3e4377de68dac3d54932df6c1994'
+    safe_revision: ead7b5fe38f4f580d5c4ca2697136acc8ef1bd8b
   ndr_support.gemspec:
     comments:
     reviewed_by: brian.shand
@@ -283,4 +283,4 @@ file safety:
   test/yaml/serialization_test.rb:
     comments:
     reviewed_by: brian.shand
-    safe_revision: '09ad2e0c210d3e4377de68dac3d54932df6c1994'
+    safe_revision: ead7b5fe38f4f580d5c4ca2697136acc8ef1bd8b

data/lib/ndr_support/version.rb

@@ -3,5 +3,5 @@
 # This defines the NdrSupport version. If you change it, rebuild and commit the gem.
 # Use "rake build" to build the gem, see rake -T for all bundler rake tasks.
 module NdrSupport
-  VERSION = '5.9.6'
+  VERSION = '5.9.7'
 end

data/lib/ndr_support/yaml/serialization_migration.rb

@@ -56,14 +56,17 @@ module NdrSupport
       # Within double quotes, YAML allows special characters.
       # While `psych` emits UTF-8 YAML, `syck` double escapes
       # higher characters. We need to unescape any we find:
+      # Both `psych` and `syck` escape lower control characters.
       def handle_special_characters!(string, coerce_invalid_chars)
-        # TODO: Change to only handle syck control characters
         return unless string.start_with?('---') # Only handle YAML that is not JSON
 
         # Replace any encoded hex chars with their actual value:
-        string.gsub!(/((?:\\x[0-9A-F]{2})+)/) do
-          byte_sequence = $1.scan(/[0-9A-F]{2}/)
-          byte_sequence.pack('H2' * byte_sequence.length).tap do |sequence|
+        string.gsub!(/(?<!\\)((?:\\\\)*)((?:\\x[0-9A-F]{2})+)/) do
+          # We use negative lookbehind and the first capturing group to skip over
+          # properly escaped backslashes
+          prefix = ::Regexp.last_match(1) # Prefix is an even number of backslashes
+          byte_sequence = ::Regexp.last_match(2).scan(/[0-9A-F]{2}/)
+          prefix + byte_sequence.pack('H2' * byte_sequence.length).tap do |sequence|
             fix_encoding!(sequence, coerce_invalid_chars)
           end
         end

data/test/yaml/serialization_test.rb

@@ -29,8 +29,14 @@ class SerializationTest < Minitest::Test
     assert_equal "control 0x01 char \n whoops!", load_yaml(chr_1_yaml)
   end
 
+  test 'should handle non-binary yaml with escaped things that look like control chars' do
+    # irb> Psych.dump(['\\x01 \\xAF \\\\xAF', "\x01 \\\x01 \x01\\\x01"])
+    escaped_yaml = "---\n- \"\\\\x01 \\\\xAF \\\\\\\\xAF\"\n- \"\\x01 \\\\\\x01 \\x01\\\\\\x01\"\n"
+    assert_equal ['\\x01 \\xAF \\\\xAF', '0x01 \\0x01 0x01\\0x01'], load_yaml(escaped_yaml)
+  end
+
   test 'should leave non-binary JSON with things that look like control chars unchanged' do
-    hash = { 'report' => ' \x09 ' }
+    hash = { 'report' => ' \x01 ' }
     assert_equal hash, load_yaml(hash.to_json)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_support
 version: !ruby/object:Gem::Version
-  version: 5.9.6
+  version: 5.9.7
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-14 00:00:00.000000000 Z
+date: 2023-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord