ndr_support 5.9.5 → 5.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bfe7ed2fab4ae654340e7aef5838dc71d904635ac4aa0d78dcee8b6d00ead31
-  data.tar.gz: 4d2b22e57baaffd236846e3505fc1303391202a48e6b3e64867dd84ca9c4e61e
+  metadata.gz: 219d266e0a79fb3e013249e574aa25648ddecd15b49421cd66c06780d63f47e8
+  data.tar.gz: 48cdd5789a4aed8be6c03993eb4d1ce7ec6bf7e5225aea7e47f5e452c641d3d0
 SHA512:
-  metadata.gz: 6d4eccd2e2c6fcf7813da447cac43f3e359057edb17af8476666ee9e40ecf71735738a5b0a0919f284a213e87c7c7d19750a78a5c17e9ac15bd7c1d3ee6a8445
-  data.tar.gz: 424d016b5959104a7778724fb71d65d205b3b3d2f9c9bfca54ca3a3c1fb4b9f8d622f2d5bb3d5584fe81d138870613ba8ae28c01982d656be754e00efa44faab
+  metadata.gz: 869d57040385f645aae2c5b1c8dcefe5c2fd2176a7f8aa71f2859764edc7d9e0553a76065a92d29f98e3e1eb2bf29c6f8c1f0ee289e3314c90e0e105112f1cd6
+  data.tar.gz: dc2263d789b440b4a153c086b7049b5983e512af444fbb7f469161967685bbe4e130e7a68e63e5e14e5f4e494804a049f662fbd973e6588dddbb3a6065452902

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 ## [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
+
 ## 5.9.5 / 2023-10-26
 * Support Rails 7.1
 

data/code_safety.yml

@@ -23,7 +23,7 @@ file safety:
   CHANGELOG.md:
     comments:
     reviewed_by: brian.shand
-    safe_revision: 2253a90ec8db872590a8167fdebe95d6ed677cc2
+    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: 45fa90daa2dd131ac0286ef7f4af1447bd01bc6c
+    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: f4f7cb0803ea34a2f1ba83495d8bcbd942786bce
+    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: f4f7cb0803ea34a2f1ba83495d8bcbd942786bce
+    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.5'
+  VERSION = '5.9.7'
 end

data/lib/ndr_support/yaml/serialization_migration.rb

@@ -56,11 +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)
+        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,6 +29,17 @@ 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' => ' \x01 ' }
+    assert_equal hash, load_yaml(hash.to_json)
+  end
+
   test 'load_yaml should not coerce to UTF-8 by default' do
     assert_yaml_coercion_behaviour
   end

metadata

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