Add DBus::Data, test and refactor PacketMarshaller, PacketUnmarshaller #103
Conversation
so that they are usable also for PacketMarshaller
using Data::Int.range add RSpec for it
…make_typed - Data::Variant: remember your type - Added Data::Basic.type Data::Basic#type - Added Data::Fixed#marshall: use it in PacketMarshaller#append - PacketMarshaller#initialize: optionally specify endianness (enabling use of the full set of tests from data/marshall.yaml)
also enable unmarshalling tests for String and ObjectPath
Much more tests needed, also to clarify the API
to silence warnings, if enabled
lib/dbus/value.rb
Outdated
| # | ||
| # A value is either {Basic} or a {Container}. | ||
| # {Basic} values are either {Fixed}-size or {StringLike}. | ||
| class Base |
There was a problem hiding this comment.
Just a general reflection, I tend to distrust deep hierarchies specially when they contain artificial intermediate classes like StringLike.
In this case, I can see it makes sense in the way it is. I just wanted to make a note that this activated my arachnid sense.
There was a problem hiding this comment.
Good point, the intermediate classes are either completely implementation detail (Int) or a direct transfer from the specification (Fixed, StringLike) and not really helpful for the user.
Would it help if their docs said "Abstract helper"?
Also, (module)Data::(class)Base could be eliminated and merged into class Data, similar to what I did in #104 with Type::Type.
A careful look is needed to determine if it can be removed. Can a bad case occur? Bad case: an inner method mutates *buffer* and then IncompleteBufferException occurs, losing the partialy unmarshalled data.
|
The Container types are still of Beta quality. I will make this a beta gem and be ready to fix bugs fast. |
This is a fix for #97.
To understand this, you should skim the Type System section of the D-Bus specification, up to and including the first table.
TODOs
Data::Containerclasses1. DBus::Data
The design principle is to allow passing around such data which carries with it its exact D-Bus type: a
42should know if it's a "y" BYTE or an "i" INT32. A["foo", "bar"]should distinguish an "as" ARRAY of STRING from "(ss)" STRUCT of 2 STRINGs.The concrete need for this was found when implementing
org.freedesktop.DBus.Properties.GetAllwhose return value is formally a dictionary of variants but those variants must each have a specific type of the individual property.The biggest change is adding the
DBus::Datamodule for exact representation of the D-Bus data types:Data::Int16,Data::UInt64,Data::Variant,Data::Arrayand so on.So far the data entering and leaving
dbus_methods are plain Ruby (Integer,Hash, ...) andDBus::Dataare used internally.2. (Un)Marshalling Reimplementation and Tests
DBus::Datais closely related to marshalling and unmarshalling, soPacketMarshallerandPacketUnmarshallerare largely reimplemented (splitting offRawMessageas a detail).The test coverage for these classes was incomplete, so a comprehensive set of tests is added, using a data driven approach serialized in
spec/data/marshall.yaml