1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
|
require 'beefcake/buffer'
module Beefcake
module Message
class WrongTypeError < StandardError
def initialize(name, exp, got)
super("Wrong type `#{got}` given for (#{name}). Expected #{exp}")
end
end
class InvalidValueError < StandardError
def initialize(name, val)
super("Invalid Value given for `#{name}`: #{val.inspect}")
end
end
class RequiredFieldNotSetError < StandardError
def initialize(name)
super("Field #{name} is required but nil")
end
end
class DuplicateFieldNumber < StandardError
def initialize(num, name)
super("Field number #{num} (#{name}) was already used")
end
end
class Field < Struct.new(:rule, :name, :type, :fn, :opts)
def <=>(o)
fn <=> o.fn
end
def same_type?(obj)
type == obj
end
def matches_type?(obj)
obj.is_a? type
end
def is_protobuf?
type.is_a?(Class) and type.include?(Beefcake::Message)
end
def required? ; rule == :required end
def repeated? ; rule == :repeated end
def optional? ; rule == :optional end
end
module Dsl
def required(name, type, fn, opts={})
field(:required, name, type, fn, opts)
end
def repeated(name, type, fn, opts={})
field(:repeated, name, type, fn, opts)
end
def optional(name, type, fn, opts={})
field(:optional, name, type, fn, opts)
end
def field(rule, name, type, fn, opts)
if fields.include?(fn)
raise DuplicateFieldNumber.new(fn, name)
end
fields[fn] = Field.new(rule, name, type, fn, opts)
attr_accessor name
end
def fields
@fields ||= {}
end
end
module Encode
def encode(buf = Buffer.new)
validate!
if ! buf.respond_to?(:<<)
raise ArgumentError, "buf doesn't respond to `<<`"
end
if ! buf.is_a?(Buffer)
buf = Buffer.new(buf)
end
# TODO: Error if any required fields at nil
__beefcake_fields__.values.sort.each do |fld|
if fld.opts[:packed]
bytes = encode!(Buffer.new, fld, 0)
buf.append_info(fld.fn, Buffer.wire_for(fld.type))
buf.append_uint64(bytes.length)
buf << bytes
else
encode!(buf, fld, fld.fn)
end
end
buf
end
def encode!(buf, fld, fn)
v = self[fld.name]
v = v.is_a?(Array) ? v : [v]
v.compact.each do |val|
case fld.type
when Class # encodable
# TODO: raise error if type != val.class
buf.append(:string, val.encode, fn)
when Module # enum
if ! valid_enum?(fld.type, val)
raise InvalidValueError.new(fld.name, val)
end
buf.append(:int32, val, fn)
else
buf.append(fld.type, val, fn)
end
end
buf
end
def write_delimited(buf = Buffer.new)
if ! buf.respond_to?(:<<)
raise ArgumentError, "buf doesn't respond to `<<`"
end
if ! buf.is_a?(Buffer)
buf = Buffer.new(buf)
end
buf.append_bytes(encode)
buf
end
def valid_enum?(mod, val)
!!name_for(mod, val)
end
def name_for(mod, val)
mod.constants.each do |name|
if mod.const_get(name) == val
return name
end
end
nil
end
def validate!
__beefcake_fields__.values.each do |fld|
if fld.rule == :required && self[fld.name].nil?
raise RequiredFieldNotSetError, fld.name
end
end
end
end
module Decode
def decode(buf, o=self.new)
if ! buf.is_a?(Buffer)
buf = Buffer.new(buf)
end
# TODO: test for incomplete buffer
while buf.length > 0
fn, wire = buf.read_info
fld = fields[fn]
# We don't have a field for with index fn.
# Ignore this data and move on.
if fld.nil?
buf.skip(wire)
next
end
exp = Buffer.wire_for(fld.type)
if wire != exp
raise WrongTypeError.new(fld.name, exp, wire)
end
if fld.rule == :repeated && fld.opts[:packed]
len = buf.read_uint64
tmp = Buffer.new(buf.read(len))
o[fld.name] ||= []
while tmp.length > 0
o[fld.name] << tmp.read(fld.type)
end
elsif fld.rule == :repeated
val = buf.read(fld.type)
o[fld.name] ||= []
o[fld.name] << val
else
val = buf.read(fld.type)
o[fld.name] = val
end
end
# Set defaults
fields.values.each do |f|
next if o[f.name] == false
o[f.name] ||= f.opts[:default]
end
o.validate!
o
end
def read_delimited(buf, o=self.new)
if ! buf.is_a?(Buffer)
buf = Buffer.new(buf)
end
return if buf.length == 0
n = buf.read_int64
tmp = Buffer.new(buf.read(n))
decode(tmp, o)
end
end
def self.included(o)
o.extend Dsl
o.extend Decode
o.send(:include, Encode)
end
# (see #assign)
def initialize(attrs={})
assign attrs
end
# Handles filling a protobuf message from a hash. Embedded messages can
# be passed in two ways, by a pure hash or as an instance of embedded class(es).
#
# @example By a pure hash.
# {:field1 => 2, :embedded => {:embedded_f1 => 'lala'}}
#
# @example Repeated embedded message by a pure hash.
# {:field1 => 2, :embedded => [
# {:embedded_f1 => 'lala'},
# {:embedded_f1 => 'lulu'}
# ]}
#
# @example As an instance of embedded class.
# {:field1 => 2, :embedded => EmbeddedMsg.new({:embedded_f1 => 'lala'})}
#
# @param [Hash] data to fill a protobuf message with.
def assign(attrs)
__beefcake_fields__.values.each do |fld|
attribute = attrs[fld.name]
if attribute.nil?
self[fld.name] = nil
next
end
unless fld.is_protobuf?
self[fld.name] = attribute
next
end
if fld.repeated? && attribute.is_a?(Hash)
self[fld.name] = fld.type.new(attribute)
next
end
if fld.repeated? && attribute.is_a?(fld.type)
self[fld.name] = [attribute]
next
end
if fld.repeated?
self[fld.name] = attribute.map do |i|
fld.matches_type?(i) ? i : fld.type.new(i)
end
next
end
if fld.matches_type? attribute
self[fld.name] = attribute
next
end
self[fld.name] = fld.type.new(attribute)
end
self
end
def __beefcake_fields__
self.class.fields
end
def [](k)
__send__(k)
end
def []=(k, v)
__send__("#{k}=", v)
end
def ==(o)
return false if (o == nil) || (o == false)
return false unless o.is_a? self.class
__beefcake_fields__.values.all? {|fld| self[fld.name] == o[fld.name] }
end
def inspect
set = __beefcake_fields__.values.select {|fld| self[fld.name] != nil }
flds = set.map do |fld|
val = self[fld.name]
case fld.type
when Class
"#{fld.name}: #{val.inspect}"
when Module
title = name_for(fld.type, val) || "-NA-"
"#{fld.name}: #{title}(#{val.inspect})"
else
"#{fld.name}: #{val.inspect}"
end
end
"<#{self.class.name} #{flds.join(", ")}>"
end
def to_hash
__beefcake_fields__.values.inject({}) do |h, fld|
v = self[fld.name]
next h if v.nil?
h[fld.name] =
case
when v.respond_to?(:to_hash)
# A nested protobuf message, so let's call its 'to_hash' method.
v.to_hash
when v.is_a?(Array)
# There can be two field types stored in array.
# Primitive type or nested another protobuf message.
# The later one has got a 'to_hash' method.
v.map { |i| i.respond_to?(:to_hash) ? i.to_hash : i }
else
v
end
h
end
end
end
end
|