Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make ValidationNotEqualError throw HEX-bytes in case of given byte arrays. #7

Merged
merged 5 commits into from
Apr 20, 2021
Merged

Make ValidationNotEqualError throw HEX-bytes in case of given byte arrays. #7

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ebe352c
Output HEX-bytes instead of letters for ValidationNotEqualError. (#5)
ams-tschoening Dec 15, 2020
8eac6e2
Use an implementation supporting other objects than byte arrays as well.
ams-tschoening Mar 3, 2021
65ca5b6
Don't handle human readable texts as byte arrays.
ams-tschoening Mar 8, 2021
ae26b02
Rephrased docs to make more clear what is meant.
ams-tschoening Mar 10, 2021
035b555
Changed phrases.
ams-tschoening Mar 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion lib/kaitai/struct/struct.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,22 @@ def to_signed(x, mask)
def self.format_hex(bytes)
bytes.unpack('H*')[0].gsub(/(..)/, '\1 ').chop
end

###
# Guess if the given args are most likely byte arrays.
# <p>
# There's no way to know for sure, but {@code Encoding::ASCII_8BIT} is a special encoding that is
# usually used for a byte array(/string), not a character string. For those reasons, that encoding
# is NOT planned to be allowed for human readable texts by KS in general as well.
# </p>
# @param args [...] Something to check.
# @see <a href="https://ruby-doc.org/core-3.0.0/Encoding.html">Encoding</a>
# @see <a href="https://github.com/kaitai-io/kaitai_struct/issues/116">List of supported encodings</a>
#
def self.is_byte_array?(*args)
found = args.select { |arg| arg.is_a?(String) and (arg.encoding == Encoding::ASCII_8BIT) }
found.length == args.length
end
generalmimon marked this conversation as resolved.
Show resolved Hide resolved
end

##
Expand Down Expand Up @@ -569,7 +585,12 @@ def initialize(msg, io, src_path)
# "expected", but it turned out that it's not.
class ValidationNotEqualError < ValidationFailedError
def initialize(expected, actual, io, src_path)
super("not equal, expected #{expected.inspect}, but got #{actual.inspect}", io, src_path)
if Stream.is_byte_array?(expected, actual)
super("not equal, expected [#{Stream.format_hex(expected)}], but got [#{Stream.format_hex(actual)}]", io, src_path)
else
super("not equal, expected #{expected.inspect}, but got #{actual.inspect}", io, src_path)
end

@expected = expected
@actual = actual
end
Expand Down